Skip to content

Commit a9f8576

Browse files
Updated documentation.
1 parent 022b81a commit a9f8576

File tree

2 files changed

+7
-20
lines changed

2 files changed

+7
-20
lines changed

docs/index.rst

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,12 @@
11
Welcome to NEAT-Python's documentation!
22
=======================================
33

4-
**NOTE**: The examples are currently being moved into a separate repository (and
5-
Python package) from the NEAT library itself. During this time if you use the
6-
code from the GitHub repository you may find that examples are missing and/or
7-
not working.
8-
94
NEAT (NeuroEvolution of Augmenting Topologies) is a method developed by Kenneth O. Stanley for evolving arbitrary neural
10-
networks. NEAT-Python is a Python implementation of NEAT.
11-
12-
The core NEAT implementation is currently pure Python with no dependencies other than the Python standard library.
13-
The `visualize` module requires graphviz, NumPy, and matplotlib, but it is not necessary to install these packages unless
14-
you want to make use of these visualization utilities. Some of the examples also make use of other libraries.
5+
networks. NEAT-Python is a pure Python implementation of NEAT, with no dependencies other than the Python standard library.
156

16-
If you need an easy performance boost, JIT-enabled `PyPy
17-
<http://pypy.org>`_ does a fantastic job, and may give you a ~10x speedup over CPython. Once version 1.0 is out,
18-
Built-in C and OpenCL network implementations will be added to speed up applications for which network evaluation is the primary bottleneck.
19-
20-
Support for HyperNEAT and other extensions to NEAT will also be added once the fundamental NEAT implementation is
7+
Support for HyperNEAT and other extensions to NEAT is planned once the fundamental NEAT implementation is
218
more complete and stable.
229

23-
**Please note:** the package and its usage may change significantly while it is still in alpha status. Updating to
24-
the most recent version is almost certainly going to break your code until the version number approaches 1.0.
25-
2610
For further information regarding general concepts and theory, please see `Selected Publications
2711
<http://www.cs.ucf.edu/~kstanley/#publications>`_ on Stanley's website, or his recent `AMA on Reddit
2812
<https://www.reddit.com/r/IAmA/comments/3xqcrk/im_ken_stanley_artificial_intelligence_professor>`_.

docs/neat_overview.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ detailed description of the algorithm, you should probably go read some of `Stan
66
<http://www.cs.ucf.edu/~kstanley/#publications>`_ on his website.
77

88
Even if you just want to get the gist of the algorithm, reading at least a couple of the early NEAT papers is a good
9-
idea. Most of them are pretty short (8 pages or fewer), and do a good job of explaining concepts (or at least pointing
10-
you to other references that will).
9+
idea. Most of them are pretty short, and do a good job of explaining concepts (or at least pointing
10+
you to other references that will). `The initial NEAT paper
11+
<http://nn.cs.utexas.edu/downloads/papers/stanley.cec02.pdf>`_ is only 6 pages long, and Section II should be enough
12+
if you just want a high-level overview.
13+
1114

1215
In the current implementation of NEAT-Python, a population of individual genomes is maintained. Each genome contains
1316
two sets of genes that describe how to build an artificial neural network:

0 commit comments

Comments
 (0)