[docs] Add schedulers, activations docs and improve datasets' docs (#219

)
asteroid-team · Aug 19, 2020 · a03b151 · a03b151
2 parents 07f5fb5 + de93494
commit a03b151
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 2 deletions.
diff --git a/docs/source/package_reference/data.rst b/docs/source/package_reference/data.rst
@@ -1,6 +1,10 @@
 PyTorch Datasets
 ================
 
+This page lists the supported datasets and their corresponding
+PyTorch's ``Dataset`` class. If you're interested in the datasets more
+than in the code, see `this page <../supported_datasets.rst>`__.
+
 .. currentmodule:: asteroid.data
 
 LibriMix
@@ -35,6 +39,10 @@ MUSDB18
 --------
 .. autoclass:: MUSDB18Dataset
 
+FUSS
+----
+.. autoclass:: FUSSDataset
+
 AVSpeech
 --------
 .. autoclass:: avspeech_dataset
diff --git a/docs/source/package_reference/masknn.rst b/docs/source/package_reference/masknn.rst
@@ -29,3 +29,19 @@ Normalization layers
 .. autofunction:: GlobLN
 .. autofunction:: ChanLN
 .. autofunction:: CumLN
+.. autofunction:: get
+
+Activation layers
+-----------------
+
+.. currentmodule:: asteroid.masknn.activations
+.. autofunction:: get
+.. autofunction:: linear
+.. autofunction:: relu
+.. autofunction:: prelu
+.. autofunction:: leaky_relu
+.. autofunction:: sigmoid
+.. autofunction:: softmax(dim=Non
+.. autofunction:: tanh
+.. autofunction:: gelu
+.. autofunction:: swish
diff --git a/docs/source/package_reference/optimizers.rst b/docs/source/package_reference/optimizers.rst
@@ -1,9 +1,48 @@
+Optimizers & Schedulers
+=======================
+
 Optimizers
-==========
+----------
 
 Asteroid relies on ``torch_optimizer`` and ``torch`` for optimizers.
 We provide a simple ``get`` method that retrieves optimizers from string,
 which makes it easy to specify optimizers from the command line.
 
+Here is a list of supported optimizers, retrievable from string:
+
+- AccSGD
+- AdaBound
+- AdaMod
+- DiffGrad
+- Lamb
+- NovoGrad
+- PID
+- QHAdam
+- QHM
+- RAdam
+- SGDW
+- Yogi
+- Ranger
+- RangerQH
+- RangerVA
+- Adam
+- RMSprop
+- SGD
+- Adadelta
+- Adagrad
+- Adamax
+- AdamW
+- ASG
+
 .. automodule:: asteroid.engine.optimizers
    :members:
+
+
+Schedulers
+----------
+
+Asteroid provides step-wise learning schedulers, integrable to
+``pytorch-lightning`` via ``System``.
+
+.. automodule:::: asteroid.engine.schedulers
+   :members:
diff --git a/docs/source/supported_datasets.rst b/docs/source/supported_datasets.rst
@@ -1,6 +1,8 @@
 Datasets and tasks
 ==================
 The following is a list of supported datasets, sorted by task.
+If you're more interested in the corresponding PyTorch ``Dataset``, see
+`this page <package_reference/data.rst>`__
 
 Speech separation
 -----------------
@@ -35,4 +37,3 @@ Audio-visual source separation
 
 Speaker extraction
 -----------------
-