This repository has been archived by the owner on Jul 10, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 221
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating the documentation to split out the mlp module into a separat…
…e file.
- Loading branch information
Showing
2 changed files
with
34 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |