Skip to content

Commit

Permalink
Added config file documentation page.
Browse files Browse the repository at this point in the history
Added link to ReadTheDocs from the README.
Updated license copyright.
  • Loading branch information
CodeReclaimers committed Oct 25, 2015
1 parent b434f74 commit aebca57
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 0 deletions.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Copyright (c) 2007-2011, cesar.gomes and mirrorballu2
Copyright (c) 2015, CodeReclaimers, LLC
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ NEAT (NeuroEvolution of Augmenting Topologies) is a method developed by Kenneth

For further information regarding general concepts and theory, please see [Selected Publications](http://www.cs.ucf.edu/~kstanley/#publications) in Stanley's website.


## Getting Started ##

If you want to try neat-python, please check out the repository, start playing with the examples (XOR, single pole balancing, or double pole balancing) and then try creating your own experiment.

The documentation, which is still a work in progress, is available on [Read The Docs](http://neat-python.readthedocs.org/en/latest/).
72 changes: 72 additions & 0 deletions docs/config_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@

Configuration file format
=========================

The configuration file is in the format described in the `Python ConfigParser documentation
<https://docs.python.org/2/library/configparser.html>`_. Currently, all values must be explicitly enumerated in the
configuration file.


[phenotype] section
-------------------

* *input_nodes*
The number of nodes through which the network receives input.

* *output_nodes*
The number of nodes to which the network delivers output.

* *fully_connected*
If this evaluates to **True**, then all individuals in the initial population will be created with
no hidden nodes, and each output will have randomly-configured connection to each input.
Otherwise, the initial population's members will have no hidden nodes, and each output will have
*only one* randomly-configured connection to a random input.

* *max_weight*, *min_weight*
Connection weights will be limited to this range.

* *feedforward*

* *nn_activation*
Type of activation function to be used to build networks.

* *hidden_nodes*
* *weight_stdev*
The standard deviation of the zero-centered normal distribution used to generate initial and replacement weights.

[genetic] section
-----------------
* *pop_size*
* *max_fitness_threshold*
* *prob_addconn*
* *prob_addnode*
* *prob_deleteconn*
* *prob_deletenode*
* *prob_mutatebias*
* *bias_mutation_power*
* *prob_mutate_response*
* *response_mutation_power*
* *prob_mutate_weight*
* *weight_mutation_power*
* *prob_togglelink*
* *elitism*

[genotype compatibility] section
--------------------------------
* *compatibility_threshold*
* *compatibility_change*
* *excess_coefficient*
* *disjoint_coefficient*
* *weight_coefficient*

[species] section
-----------------
* *species_size*
* *survival_threshold*
* *old_threshold*
* *youth_threshold*
* *old_penalty*
* *youth_boost*
* *max_stagnation*


1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Contents:
:maxdepth: 2

neat_overview
config_file
xor_example


Expand Down

0 comments on commit aebca57

Please sign in to comment.