Address some import and naming issues for documentation

JohnVinyard · Jun 25, 2018 · 3480103 · 3480103
1 parent 4490e31
commit 3480103
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -116,7 +116,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -326,6 +326,12 @@
     'matplotlib',
 
     'zounds.nputil.countbits',
+
+    'torch',
+    'torch.nn',
+    'torch.nn.functional',
+    'torch.optim',
+    'torch.autograd'
 ]
 
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -22,6 +22,7 @@ API documentation
     core
     synthesize
     datasets
+    learn
 
 Indices and tables
 ------------------

diff --git a/docs/source/learn.rst b/docs/source/learn.rst
@@ -27,13 +27,12 @@ Sampling
 Machine Learning Models
 -----------------------
 .. autoclass:: KMeans
-.. autoclass:: SkLearnModel
+.. autoclass:: SklearnModel
 .. autoclass:: PyTorchNetwork
 .. autoclass:: PyTorchGan
 .. autoclass:: PyTorchAutoEncoder
 .. autoclass:: SupervisedTrainer
 .. autoclass:: TripletEmbeddingTrainer
-.. autoclass:: GanTrainer
 .. autoclass:: WassersteinGanTrainer
 
 Hashing

diff --git a/zounds/learn/__init__.py b/zounds/learn/__init__.py
@@ -14,7 +14,8 @@
 from preprocess import \
     MeanStdNormalization, UnitNorm, Log, PreprocessingPipeline, Multiply, \
     Slicer, InstanceScaling, Reshape, Weighted, MuLawCompressed, SimHash, \
-    AbsoluteValue, Binarize, Sharpen
+    AbsoluteValue, Binarize, Sharpen, Pipeline, PreprocessResult, Preprocessor, \
+    PipelineResult
 
 from sklearn_preprocessor import SklearnModel, WithComponents
 

diff --git a/zounds/spectral/__init__.py b/zounds/spectral/__init__.py
@@ -4,7 +4,8 @@
 """
 
 from sliding_window import \
-    SlidingWindow, OggVorbisWindowingFunc, WindowingFunc, HanningWindowingFunc
+    SlidingWindow, OggVorbisWindowingFunc, WindowingFunc, \
+    HanningWindowingFunc, IdentityWindowingFunc
 
 from spectral import \
     FFT, DCT, DCTIV, MDCT, BarkBands, Chroma, BFCC, SpectralCentroid, \