README.md in ruby-dnn-0.9.4 vs README.md in ruby-dnn-0.10.0
- old
+ new
@@ -1,6 +1,7 @@
# ruby-dnn
+[](https://badge.fury.io/rb/ruby-dnn)
ruby-dnn is a ruby deep learning library. This library supports full connected neural network and convolution neural network.
Currently, you can get 99% accuracy with MNIST and 74% with CIFAR 10.
## Installation
@@ -19,14 +20,49 @@
$ gem install ruby-dnn
## Usage
-Currently, only simple Japanese documents are available.
-Please refer to examples for basic usage.
+### MNIST MLP example
+
+```ruby
+model = Model.new
+
+model << InputLayer.new(784)
+
+model << Dense.new(256)
+model << ReLU.new
+
+model << Dense.new(256)
+model << ReLU.new
+
+model << Dense.new(10)
+
+model.compile(RMSProp.new, SoftmaxCrossEntropy.new)
+
+model.train(x_train, y_train, 10, batch_size: 100, test: [x_test, y_test])
+
+```
+
+Please refer to examples for basic usage.
If you want to know more detailed information, please refer to the source code.
+## Implemented
+|| Implemented classes |
+|:-----------|------------:|
+| Connections | Dense, Conv2D, Conv2D_Transpose, SimpleRNN, LSTM, GRU |
+| Layers | Flatten, Reshape, Dropout, BatchNormalization, MaxPool2D, AvgPool2D, UnPool2D |
+| Activations | Sigmoid, Tanh, Softsign, Softplus, Swish, ReLU, LeakyReLU, ELU |
+| Optimizers | SGD, Nesterov, AdaGrad, RMSProp, AdaDelta, Adam, RMSPropGraves |
+| Losses | MeanSquaredError, MeanAbsoluteError, HuberLoss, SoftmaxCrossEntropy, SigmoidCrossEntropy |
+
+## TODO
+● Add CI badge.
+● Write a test.
+● Write a document.
+● Support to GPU.
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake "spec"` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -39,6 +75,6 @@
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
-Everyone interacting in the Dnn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dnn/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ruby-dnn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dnn/blob/master/CODE_OF_CONDUCT.md).