Test AutoAPI

MelJan · Apr 7, 2017 · e7d5d08 · e7d5d08
1 parent f72ed22
commit e7d5d08
Show file tree

Hide file tree

Showing 8 changed files with 195 additions and 309 deletions.
diff --git a/docs/base.rst b/docs/base.rst
@@ -0,0 +1,50 @@
+.. automodule:: pydeep.base
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+activationfunction
+###############################
+
+.. automodule:: pydeep.base.activationfunction
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+basicstructure
+###############################
+
+.. automodule:: pydeep.base.basicstructure
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+corruptor
+###############################
+
+.. automodule:: pydeep.base.corruptor
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+costfunction
+###############################
+
+.. automodule:: pydeep.base.costfunction
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+numpyextension
+###############################
+
+.. automodule:: pydeep.base.numpyextension
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
diff --git a/docs/documentation.rst b/docs/documentation.rst
@@ -2,305 +2,35 @@
 Documentation
 ===================
 
+pydeep
+===================
+
 .. automodule:: pydeep
    :members:
    :private-members:
    :special-members: __init__
    :inherited-members:
 
 base
---------------------------
-
-.. automodule:: pydeep.base
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-activationfunction
-``````````````````````````
-
-.. automodule:: pydeep.base.activationfunction
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-basicstructure
-``````````````````````````
-
-.. automodule:: pydeep.base.basicstructure
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-corruptor
-``````````````````````````
-
-.. automodule:: pydeep.base.corruptor
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-costfunction
-``````````````````````````
-
-.. automodule:: pydeep.base.costfunction
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-numpyextension
-``````````````````````````
-
-.. automodule:: pydeep.base.numpyextension
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
+###############################
+.. toctree::
+   :maxdepth: 8
+   base<base.rst>
 
 misc
---------------------------
-
-.. automodule:: pydeep.misc
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-io
-``````````````````````````
-
-.. automodule:: pydeep.misc.io
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-measuring
-``````````````````````````
-
-.. automodule:: pydeep.misc.measuring
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-sshthreadpool
-``````````````````````````
-
-.. automodule:: pydeep.misc.sshthreadpool
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-toyproblems
-``````````````````````````
-
-.. automodule:: pydeep.misc.toyproblems
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-visualization
-``````````````````````````
-
-.. automodule:: pydeep.misc.visualization
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-rbm
---------------------------
-
-.. automodule:: pydeep.rbm
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-model
-``````````````````````````
-
-.. automodule:: pydeep.rbm.model
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-trainer
-``````````````````````````
-
-.. automodule:: pydeep.rbm.trainer
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-CD
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.dbn.IndependentParallelTemperingSampler
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-PCD
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.dbn.IndependentParallelTemperingSampler
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-PT
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.dbn.IndependentParallelTemperingSampler
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-IPT
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.dbn.IndependentParallelTemperingSampler
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-Exact Gradient
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.trainer.GD
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-sampler
-``````````````````````````
-
-.. automodule:: pydeep.rbm.sampler
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-Gibbs
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.sampler.IndependentParallelTempering
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-PersistentGibbs
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.sampler.IndependentParallelTempering
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-ParallelTempering
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.sampler.ParallelTempering
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-IndependentParallelTempering
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.sampler.IndependentParallelTempering
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-estimator
-``````````````````````````
-
-.. automodule:: pydeep.rbm.estimator
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-dbn
-``````````````````````````
-
-.. automodule:: pydeep.rbm.dbn
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-DBN
-''''''''''''''''''''''''''
-
-.. autoclass:: pydeep.rbm.dbn.DBN
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
+###############################
+.. toctree::
+   :maxdepth: 8
+   misc<misc.rst>
 
 preprocessing
---------------------------
+###############################
+.. toctree::
+   :maxdepth: 8
+   preprocessing<preprocessing.rst>
 
-.. automodule:: pydeep.preprocessing
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-STANDARIZER
-``````````````````````````
-
-.. autoclass:: pydeep.preprocessing.STANDARIZER
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-PCA
-``````````````````````````
-
-.. autoclass:: pydeep.preprocessing.PCA
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-ZCA
-``````````````````````````
-
-.. autoclass:: pydeep.preprocessing.PCA
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
-ICA
-``````````````````````````
-
-.. autoclass:: pydeep.preprocessing.PCA
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
+rbm
+###############################
+.. toctree::
+   :maxdepth: 8
+   rbm<rbm.rst>
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,6 +8,7 @@ Welcome to PyDeep
 ===================
 
 .. toctree::
+   :maxdepth: 6
    :caption: Contents:
 
 Installation
@@ -34,7 +35,6 @@ Documentation
 
    Documentation<documentation.rst>
 
-===================
 Indices and tables
 ===================