diff --git a/LICENSE b/LICENSE index 2774e0c0..63b03118 100644 --- a/LICENSE +++ b/LICENSE @@ -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 diff --git a/README.md b/README.md index 373c7997..e0cf4476 100644 --- a/README.md +++ b/README.md @@ -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/). \ No newline at end of file diff --git a/docs/config_file.rst b/docs/config_file.rst new file mode 100644 index 00000000..06a9bf6a --- /dev/null +++ b/docs/config_file.rst @@ -0,0 +1,72 @@ + +Configuration file format +========================= + +The configuration file is in the format described in the `Python ConfigParser documentation +`_. 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* + + diff --git a/docs/index.rst b/docs/index.rst index 3cd9e6a2..c41acd27 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,6 +22,7 @@ Contents: :maxdepth: 2 neat_overview + config_file xor_example