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

Commit

Permalink
Updating the documentation to split out the mlp module into a separat…
Browse files Browse the repository at this point in the history
…e file.
  • Loading branch information
alexjc committed Apr 21, 2015
1 parent 0c35e3f commit dcfbb49
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
Welcome to scikit-neuralnetwork's documentation!
================================================

.. autoclass:: sknn.mlp.MultiLayerPerceptronRegressor
:members:
:inherited-members:
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.

.. autoclass:: sknn.mlp.MultiLayerPerceptronClassifier
:members:
:inherited-members:
|Build Status| |Documentation Status| |Code Coverage|

----

Modules
=======

.. toctree::
:maxdepth: 2

mlp


Indices & Search
================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. |Build Status| image:: https://travis-ci.org/aigamedev/scikit-neuralnetwork.svg?branch=master
:target: https://travis-ci.org/aigamedev/scikit-neuralnetwork

.. |Documentation Status| image:: https://readthedocs.org/projects/scikit-neuralnetwork/badge/?version=latest
:target: http://scikit-neuralnetwork.readthedocs.org/

.. |Code Coverage| image:: https://coveralls.io/repos/aigamedev/scikit-neuralnetwork/badge.svg?branch=master
:target: https://coveralls.io/r/aigamedev/scikit-neuralnetwork?branch=master
14 changes: 14 additions & 0 deletions docs/mlp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
:mod:`sknn.mlp`
===============

.. automodule:: sknn.mlp

.. autoclass:: sknn.mlp.MultiLayerPerceptronRegressor
:members:
:inherited-members:
:special-members:

.. autoclass:: sknn.mlp.MultiLayerPerceptronClassifier
:members:
:inherited-members:
:special-members:

0 comments on commit dcfbb49

Please sign in to comment.