Skip to content

Commit 22016f2

Browse files
committed
Add github pages javadoc link to README
1 parent f2614ad commit 22016f2

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ An implementation of the NEAT (Neuroevolution through augmenting topologies) alg
33

44
## Features
55
* *Fully* documented code base ideal for learning and people new to the subject
6-
* Super friendly highly abstracated interfaces that hide the implementation details so you can focus on your use case
6+
* Documentation can be found [here](https://jwblangley.github.io/neat-ml/)
7+
* Super friendly highly abstracted interfaces that hide the implementation details, so you can focus on your use case
78
* Friendly implementations of both genotypes and phenotypes
89
* All you need to worry about is inputs, outputs and fitness!
910
* Multi-threading support for concurrent genotype evaluation just by specifying the number of worker threads
10-
* Neural network visualiser to create images so you can see what networks are being created
11+
* Neural network visualiser to create images, so you can see what networks are created
1112
* Full serializing and deserializing support using [google's protobuf](https://developers.google.com/protocol-buffers), allowing you to save interesting genotypes (networks) or even save your training progress to disk!
1213

1314
## Quick start
@@ -119,7 +120,7 @@ public class LearnXor {
119120

120121
### Visualiser
121122

122-
Visalising a neural network is a great way to understand a bit about what is going on and it also looks great!
123+
Visualising a neural network is a great way to understand a bit about what is going on and it also looks great!
123124
The visualiser in this library has the following features:
124125
* Different colours for positive and negative weights
125126
* Orange for positive
@@ -146,7 +147,7 @@ This can achieve results like this:
146147

147148
### Serialise
148149
#### Networks
149-
You can save a particular network genotype for later use. This could be so that you can keep track of the best/most interesting individuals and have them evaluate without the need for training. This is a great utility that has many uses: for example embedding in games as the AI!
150+
You can save a particular network genotype for later use. This could be so that you can keep track of the best/most interesting individuals and have them evaluate without the need for training. This is a great utility with many uses: for example embedding in games as the AI!
150151

151152
To write a network genotype to a file:
152153
```java

0 commit comments

Comments
 (0)