Skip to content
This repository has been archived by the owner on Jul 10, 2021. It is now read-only.

Commit

Permalink
Minor updates to the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexjc committed Apr 21, 2015
1 parent 7e67b18 commit cce4cc3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ With that done, you can run the samples and benchmarks available in the ``exampl
Demonstration
-------------

To run a visualization that uses the `sknn.mlp.MultiLayerPerceptron` just run the following command::
To run a visualization that uses the ``sknn.mlp.MultiLayerPerceptronClassifier`` just run the following command::

> PYTHONPATH=. python examples/plot_mlp.py --params activation
> python examples/plot_mlp.py --params activation

There are multiple parameters you can plot as well, for example ``iterations``, ``rules`` or ``units``. The datasets are randomized each time, but the output should be an image that looks like this...

Expand All @@ -39,7 +39,11 @@ There are multiple parameters you can plot as well, for example ``iterations``,
Benchmarks
----------

Here are the results of testing 10 epochs of training for two-thirds of the original MNIST data, on Ubuntu 14.04 and a GeForce GTX 650 (Memory: 1024Mb, Cores: 384). You can run ``examples/bench_mnist.py`` to get the results.
Here are the results of testing 10 epochs of training for two-thirds of the original MNIST data, on Ubuntu 14.04 and a GeForce GTX 650 (Memory: 1024Mb, Cores: 384). You can run the following command::

> python examples/bench_mnist.py (sknn|lasagne)

...to generate the results below.

.. class:: center

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Welcome to scikit-neuralnetwork's documentation!
================================================

Deep neural network implementation without the learning cliff! This library implements multi-layer perceptrons as a wrapper for the powerful pylearn2 library that's compatible with scikit-learn for a more user-friendly and Pythonic interface.
Deep neural network implementation without the learning cliff! This library implements multi-layer perceptrons as a wrapper for the powerful ``pylearn2`` library that's compatible with ``scikit-learn`` for a more user-friendly and Pythonic interface.

|Build Status| |Documentation Status| |Code Coverage|

Expand Down

0 comments on commit cce4cc3

Please sign in to comment.