Skip to content

Commit ae1d342

Browse files
Updated documentation.
1 parent 51c7bfa commit ae1d342

File tree

3 files changed

+21
-41
lines changed

3 files changed

+21
-41
lines changed

docs/config_file.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ All settings must be explicitly enumerated in the configuration file. This make
1010
that library code changes will result in your project silently using different NEAT settings. However,
1111
it is not necessary that they appear in any certain order.
1212

13+
Note that the `Config` constructor also requires you to explicitly specify the types that will be used
14+
for the NEAT simulation. This, again, is to help avoid silent changes in behavior.
15+
1316
[NEAT] section
1417
--------------
1518

@@ -81,7 +84,7 @@ required for your particular implementation.
8184
* *bias_max_value*
8285
The maximum allowed bias value. Biases above this value will be clamped to this value.
8386
* *bias_min_value*
84-
The minimum allowed bias value. Biases blow this value will be clamped to this value.
87+
The minimum allowed bias value. Biases below this value will be clamped to this value.
8588
* *bias_mutate_power*
8689
The standard deviation of the zero-centered normal distribution from which a bias value mutation is drawn.
8790
* *bias_mutate_rate*
@@ -135,7 +138,7 @@ required for your particular implementation.
135138
* *response_max_value*
136139
The maximum allowed response value. Responses above this value will be clamped to this value.
137140
* *response_min_value*
138-
The minimum allowed response value. Responses blow this value will be clamped to this value.
141+
The minimum allowed response value. Responses below this value will be clamped to this value.
139142
* *response_mutate_power*
140143
The standard deviation of the zero-centered normal distribution from which a response value mutation is drawn.
141144
* *response_mutate_rate*
@@ -150,7 +153,7 @@ required for your particular implementation.
150153
* *weight_max_value*
151154
The maximum allowed weight value. Weights above this value will be clamped to this value.
152155
* *weight_min_value*
153-
The minimum allowed weight value. Weights blow this value will be clamped to this value.
156+
The minimum allowed weight value. Weights below this value will be clamped to this value.
154157
* *weight_mutate_power*
155158
The standard deviation of the zero-centered normal distribution from which a weight value mutation is drawn.
156159
* *weight_mutate_rate*

docs/customization.rst

Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ it with an object which implements the same interface as `BaseReporter`.
3232
<https://github.com/CodeReclaimers/neat-python/blob/master/neat/reporting.py#L56>`_ may be useful as examples of the
3333
behavior you can add using a reporter.
3434

35+
TODO: document reporter interface
36+
3537
Species stagnation scheme
3638
-------------------------
3739

@@ -49,38 +51,31 @@ Reproduction scheme
4951
The default reproduction scheme uses explicit fitness sharing and a fixed species stagnation limit. This behavior
5052
is encapsulated in the DefaultReproduction class.
5153

52-
TODO: document reproduction interface, include example
54+
TODO: document reproduction interface
5355

54-
EXAMPLE: ???
56+
TODO: include example
5557

5658
Speciation
5759
----------
5860

59-
If you need to change the speciation scheme, you should subclass `Population` and override the `_speciate` method (or,
61+
If you need to change the speciation scheme, you may specify a subclass `Population` and override the `_speciate` method (or,
6062
if you must, `monkey patch/duck punch
6163
<https://en.wikipedia.org/wiki/Monkey_patch>`_ it).
6264

63-
EXAMPLE: ???
64-
65-
Diversity
66-
---------
67-
68-
To use a different diversity scheme, you can create a custom class whose interface matches that of
69-
`ExplicitFitnessSharing` and set the `diversity_type` of your Config instance to this class.
70-
71-
TODO: document, include example
72-
73-
EXAMPLE: ???
65+
TODO: include example
7466

7567
Using different genome types
7668
----------------------------
7769

7870
To use a different genome type, you can create a custom class whose interface matches that of
79-
`Genome` or `FFGenome`, and set the `genotype` member of your Config instance to this class.
71+
`DefaultGenome` and pass this as the first argument to the `Config` constructor (that is, the
72+
`genome_type` parameter).
73+
74+
TODO: document genome interface
8075

81-
TODO: document genome interface, include example
76+
This is demonstrated in the `circuit evolution
77+
<https://github.com/CodeReclaimers/neat-python/blob/master/examples/circuits/evolve.py>`_ example.
8278

83-
EXAMPLE: PySpice circuit evolution
8479

8580
Using a different gene type
8681
---------------------------
@@ -89,22 +84,4 @@ To use a different gene type, you can create a custom class whose interface matc
8984
`NodeGene` or `ConnectionGene`, and set the `node_gene_type` or `conn_gene_type` member,
9085
respectively, of your Config instance to this class.
9186

92-
TODO: document, include example
93-
94-
EXAMPLE: ??? reference the IZNN genes?
95-
96-
Using a different network type
97-
------------------------------
98-
99-
EXAMPLE: ???
100-
101-
Cross-validation
102-
----------------
103-
104-
EXAMPLE: ???
105-
106-
Custom evaluators
107-
-----------------
108-
109-
TODO: Include a couple of evaluators to take the place of a simple function: one that uses
110-
a thread pool, and another that farms out evaluation to clients that connect over the network.
87+
TODO: include example

docs/xor_example.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ the `archived source for that release
7474

7575
Here's the entire example:
7676

77-
.. literalinclude:: ../examples/xor/xor2.py
77+
.. literalinclude:: ../examples/xor/evolve-feedforward.py
7878

7979
and here is the associated config file:
8080

81-
.. literalinclude:: ../examples/xor/xor2_config
81+
.. literalinclude:: ../examples/xor/config-feedforward

0 commit comments

Comments
 (0)