Updated documentation.

Author: CodeReclaimers

docs/config_file.rst

@@ -10,6 +10,9 @@ All settings must be explicitly enumerated in the configuration file.  This make
 that library code changes will result in your project silently using different NEAT settings.  However,
 it is not necessary that they appear in any certain order.
 
+Note that the `Config` constructor also requires you to explicitly specify the types that will be used
+for the NEAT simulation.  This, again, is to help avoid silent changes in behavior.
+
 [NEAT] section
 --------------
 
@@ -81,7 +84,7 @@ required for your particular implementation.
 * *bias_max_value*
     The maximum allowed bias value.  Biases above this value will be clamped to this value.
 * *bias_min_value*
-    The minimum allowed bias value.  Biases blow this value will be clamped to this value.
+    The minimum allowed bias value.  Biases below this value will be clamped to this value.
 * *bias_mutate_power*
     The standard deviation of the zero-centered normal distribution from which a bias value mutation is drawn.
 * *bias_mutate_rate*
@@ -135,7 +138,7 @@ required for your particular implementation.
 * *response_max_value*
     The maximum allowed response value. Responses above this value will be clamped to this value.
 * *response_min_value*
-    The minimum allowed response value. Responses blow this value will be clamped to this value.
+    The minimum allowed response value. Responses below this value will be clamped to this value.
 * *response_mutate_power*
     The standard deviation of the zero-centered normal distribution from which a response value mutation is drawn.
 * *response_mutate_rate*
@@ -150,7 +153,7 @@ required for your particular implementation.
 * *weight_max_value*
     The maximum allowed weight value. Weights above this value will be clamped to this value.
 * *weight_min_value*
-    The minimum allowed weight value. Weights blow this value will be clamped to this value.
+    The minimum allowed weight value. Weights below this value will be clamped to this value.
 * *weight_mutate_power*
     The standard deviation of the zero-centered normal distribution from which a weight value mutation is drawn.
 * *weight_mutate_rate*

docs/customization.rst

@@ -32,6 +32,8 @@ it with an object which implements the same interface as `BaseReporter`.
 <https://github.com/CodeReclaimers/neat-python/blob/master/neat/reporting.py#L56>`_ may be useful as examples of the
 behavior you can add using a reporter.
 
+TODO: document reporter interface
+
 Species stagnation scheme
 -------------------------
 
@@ -49,38 +51,31 @@ Reproduction scheme
 The default reproduction scheme uses explicit fitness sharing and a fixed species stagnation limit.  This behavior
 is encapsulated in the DefaultReproduction class.
 
-TODO: document reproduction interface, include example
+TODO: document reproduction interface
 
-EXAMPLE: ???
+TODO: include example
 
 Speciation
 ----------
 
-If you need to change the speciation scheme, you should subclass `Population` and override the `_speciate` method (or,
+If you need to change the speciation scheme, you may specify a  subclass `Population` and override the `_speciate` method (or,
 if you must, `monkey patch/duck punch
 <https://en.wikipedia.org/wiki/Monkey_patch>`_ it).
 
-EXAMPLE: ???
-
-Diversity
----------
-
-To use a different diversity scheme, you can create a custom class whose interface matches that of
-`ExplicitFitnessSharing` and set the `diversity_type` of your Config instance to this class.
-
-TODO: document, include example
-
-EXAMPLE: ???
+TODO: include example
 
 Using different genome types
 ----------------------------
 
 To use a different genome type, you can create a custom class whose interface matches that of
-`Genome` or `FFGenome`, and set the `genotype` member of your Config instance to this class.
+`DefaultGenome` and pass this as the first argument to the `Config` constructor (that is, the
+`genome_type` parameter).
+
+TODO: document genome interface
 
-TODO: document genome interface, include example
+This is demonstrated in the `circuit evolution
+<https://github.com/CodeReclaimers/neat-python/blob/master/examples/circuits/evolve.py>`_ example.
 
-EXAMPLE: PySpice circuit evolution
 
 Using a different gene type
 ---------------------------
@@ -89,22 +84,4 @@ To use a different gene type, you can create a custom class whose interface matc
 `NodeGene` or `ConnectionGene`, and set the `node_gene_type` or `conn_gene_type` member,
 respectively, of your Config instance to this class.
 
-TODO: document, include example
-
-EXAMPLE: ???  reference the IZNN genes?
-
-Using a different network type
-------------------------------
-
-EXAMPLE: ???
-
-Cross-validation
-----------------
-
-EXAMPLE: ???
-
-Custom evaluators
------------------
-
-TODO: Include a couple of evaluators to take the place of a simple function: one that uses
-a thread pool, and another that farms out evaluation to clients that connect over the network.
+TODO: include example

docs/xor_example.rst

@@ -74,8 +74,8 @@ the `archived source for that release
 
 Here's the entire example:
 
-.. literalinclude:: ../examples/xor/xor2.py
+.. literalinclude:: ../examples/xor/evolve-feedforward.py
 
 and here is the associated config file:
 
-.. literalinclude:: ../examples/xor/xor2_config
+.. literalinclude:: ../examples/xor/config-feedforward