Skip to content

Commit 6ea7824

Browse files
committed
README improvements
1 parent 4092fb3 commit 6ea7824

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
Neural Net (in Ruby)
22
===
33

4-
A [feedforward neural network](http://en.wikipedia.org/wiki/Feedforward_neural_network) with [resilient backpropagation](http://en.wikipedia.org/wiki/Rprop) (Rprop). It's ~250 loc, with no external dependencies.
4+
A [feedforward neural network](http://en.wikipedia.org/wiki/Feedforward_neural_network) with [resilient backpropagation](http://en.wikipedia.org/wiki/Rprop) (Rprop). It's ~250 loc, 100% Ruby, with no external dependencies.
55

6-
Run ```iris.rb``` to see an example of solving a simple classification problem: predict the species of iris flower based on sepal and petal size.
6+
This implementation trains significantly faster than [ai4r](https://github.com/SergioFierens/ai4r)'s backpropagation neural network, mainly because the Rprop training algorithm implemented here is much faster than the non-batch backpropagation algorithm used in ai4r.
77

8-
Sources and inspirations:
8+
However, this implementation is significantly slower than [ruby-fann](https://github.com/tangledpath/ruby-fann), which wraps the FANN library, written in C. If you're looking for something production-ready, use ruby-fann.
9+
10+
11+
Examples
12+
---
13+
- ```iris.rb```: solves a simple classification problem: predict the species of iris flower based on sepal and petal size.
14+
- ```mnist.rb```: performs OCR on handwritten digits. Requires download of MNIST dataset; see instructions at top of file.
15+
16+
17+
Sources and inspirations
18+
---
919

1020
- [Introduction to the Math of Neural Networks](http://www.amazon.com/Introduction-Math-Neural-Networks-Heaton-ebook/dp/B00845UQL6)
1121
- [Thoughtful Machine Learning: A Test-Driven Approach](http://www.amazon.com/Thoughtful-Machine-Learning-Test-Driven-Approach/dp/1449374069)

0 commit comments

Comments
 (0)