Changeset 1079

Timestamp:

02/17/21 14:32:44 (4 years ago)

Author:

Maciej Komosinski

Message:

Cosmetic

File:

• framspy/FramsticksCLI.py (modified) (5 diffs)

framspy/FramsticksCLI.py

@@ -11 +11 @@
 
 class FramsticksCLI:
-        """Runs Framsticks CLI (command-line) executable and communicates with it using standard input and output.
+        """Note: instead of this class, you should use the simpler, faster, and more reliable FramsticksLib.py.
+        
+        This class runs Framsticks CLI (command-line) executable and communicates with it using standard input and output.
         You can perform basic operations like mutation, crossover, and evaluation of genotypes.
         This way you can perform evolution controlled by python as well as access and manipulate genotypes.
@@ -21 +23 @@
 
         PRINT_FRAMSTICKS_OUTPUT: bool = False  # set to True for debugging
-        DETERMINISTIC: bool = False  # set to True to have the same results on each run
+        DETERMINISTIC: bool = False  # set to True to have the same results in each run
 
         GENO_SAVE_FILE_FORMAT = Enum('GENO_SAVE_FILE_FORMAT', 'NATIVEFRAMS RAWGENO')  # how to save genotypes
@@ -236 +238 @@
                 """
                 Returns:
-                        The genotype of the offspring. Empty string if the crossing over failed.
+                        The genotype of the offspring. self.GENOTYPE_INVALID if the crossing over failed.
                 """
                 files = self.__runCommand(self.CROSSOVER_CMD, [genotype_parent1, genotype_parent2], self.CROSSOVER_FILE, self.GENO_SAVE_FILE_FORMAT["RAWGENO"])
@@ -302 +304 @@
         # - "vectorize" crossover so that many genotypes is handled in one call. Even better, use .so/.dll direct communication to CLI
         # - use threads for non-blocking reading from frams' stdout and thus not relying on specific strings printed by frams
-        # - a pool of binaries run at the same time, balance load - in particular evaluation
+        # - a pool of binaries running simultaneously, balance load - in particular evaluation
         # - if we read genotypes in "org:" format anywhere: import https://pypi.org/project/framsreader and use it if successful,
         #    if not then print a message "framsreader not available, using simple internal method to save a genotype" and proceed as it is now.
@@ -317 +319 @@
         parent2 = parent1
         MUTATE_COUNT = 10
-        for x in range(MUTATE_COUNT):  # example of a chain of 20 mutations
+        for x in range(MUTATE_COUNT):  # example of a chain of 10 mutations
                 parent2 = framsCLI.mutate([parent2])[0]
         print("\tParent1 (mutated simplest):", parent1)