Test AutoAPI

MelJan · Apr 7, 2017 · f5be897 · f5be897
1 parent 4d6a7b6
commit f5be897
Show file tree

Hide file tree

Showing 2 changed files with 94 additions and 4 deletions.
diff --git a/docs/documentation.rst b/docs/documentation.rst
@@ -146,6 +146,51 @@ trainer
    :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
 ``````````````````````````
 
@@ -155,6 +200,42 @@ sampler
    :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
 ``````````````````````````
 
@@ -173,6 +254,15 @@ dbn
    :special-members: __init__
    :inherited-members:
 
+DBN
+''''''''''''''''''''''''''
+
+.. autoclass:: pydeep.rbm.dbn.DBN
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
 preprocessing
 --------------------------
 

diff --git a/pydeep/rbm/sampler.py b/pydeep/rbm/sampler.py
@@ -49,7 +49,7 @@
 import exceptions as ex
 
 
-class GibbsSampler(object):
+class Gibbs(object):
     """ Implementation of k-step Gibbs-sampling for bipartite graphs.
           
     """
@@ -137,7 +137,7 @@ def sample_from_h(self,
             return vis
 
 
-class PersistentGibbsSampler(object):
+class PersistentGibbs(object):
     """ Implementation of k-step persistent Gibbs sampling.
           
     """
@@ -228,7 +228,7 @@ def sample(self,
             return samples[0:num_samples, :]
 
 
-class ParallelTemperingSampler(object):
+class ParallelTempering(object):
     """ Implementation of k-step parallel tempering sampling.
           
     """
@@ -424,7 +424,7 @@ def _swap_chains(cls,
                     hid_states[[t, t + 1], :] = hid_states[[t + 1, t], :]
 
 
-class IndependentParallelTemperingSampler(object):
+class IndependentParallelTempering(object):
     """ Implementation of k-step independent parallel tempering sampling. IPT runs an PT instance for each sample in \
         parallel. This speeds up the sampling but also decreases the mixing rate.