Updates docs and README with pylissom feature list

hernanbari · Oct 20, 2018 · 0b38a5f · 0b38a5f
1 parent 4dce764
commit 0b38a5f
Show file tree

Hide file tree

Showing 11 changed files with 61 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,21 @@ The library and API documentation are at: https://pylissom.readthedocs.io/, you
 [Orientation Maps and pylissom tools](https://nbviewer.jupyter.org/github/hernanbari/pylissom/blob/master/notebooks/Orientation_maps_and_tools.ipynb)
 
 
+The main features provided by **pylissom** are:
+
+- LISSOM's activation
+
+- LISSOM's hebbian learning mechanism and others
+
+- Configuration and model building tools
+
+- Common Guassian stimuli for LISSOM experiments
+
+- Plotting helpers
+
+- Training pipeline objects
+
+
 Installation
 ------------
 

diff --git a/docs/_modules/pylissom.datasets.rst b/docs/_modules/pylissom.datasets.rst
@@ -1,3 +1,5 @@
+.. _datasets:
+
 pylissom.datasets
 =========================
 

diff --git a/docs/_modules/pylissom.models.rst b/docs/_modules/pylissom.models.rst
@@ -1,3 +1,5 @@
+.. _models:
+
 pylissom.models
 =======================
 

diff --git a/docs/_modules/pylissom.nn.modules.rst b/docs/_modules/pylissom.nn.modules.rst
@@ -1,3 +1,5 @@
+.. _nn_module:
+
 pylissom.nn.modules
 ===========================
 

diff --git a/docs/_modules/pylissom.optim.rst b/docs/_modules/pylissom.optim.rst
@@ -1,3 +1,5 @@
+.. _optim:
+
 pylissom.optim
 ======================
 

diff --git a/docs/_modules/pylissom.utils.config.rst b/docs/_modules/pylissom.utils.config.rst
@@ -1,3 +1,5 @@
+.. _config:
+
 pylissom.utils.config
 =============================
 

diff --git a/docs/_modules/pylissom.utils.plotting.rst b/docs/_modules/pylissom.utils.plotting.rst
@@ -1,3 +1,5 @@
+.. _plotting:
+
 pylissom.utils.plotting
 ===============================
 

diff --git a/docs/_modules/pylissom.utils.rst b/docs/_modules/pylissom.utils.rst
@@ -25,6 +25,8 @@ pylissom.utils.orientation\_maps module
     :undoc-members:
     :show-inheritance:
 
+.. _stimuli:
+
 pylissom.utils.stimuli module
 -----------------------------
 

diff --git a/docs/_modules/pylissom.utils.training.rst b/docs/_modules/pylissom.utils.training.rst
@@ -1,3 +1,5 @@
+.. _training:
+
 pylissom.utils.training
 ===============================
 
@@ -25,6 +27,8 @@ pylissom.utils.training.grid\_search module
     :undoc-members:
     :show-inheritance:
 
+.. _pipeline:
+
 pylissom.utils.training.pipeline module
 ---------------------------------------
 

diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst
@@ -5,6 +5,6 @@ You should first install PyTorch with conda as explained at: https://pytorch.org
 
 Install PyLissom by running:
 
-    pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pylissom
+    ``pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pylissom``
 
 The code is hosted in pypi: https://test.pypi.org/project/pylissom/
diff --git a/docs/usage/tutorials.rst b/docs/usage/tutorials.rst
@@ -2,12 +2,37 @@
 Getting Started
 ---------------
 
-There are Jupyter notebooks with tutorials at the `github's page <https://github.com/hernanbari/pylissom>`_ of the project. If Github is not rendering them, we leave these links at your disposal:
+There are Jupyter notebooks with tutorials at the `github's page <https://github.com/hernanbari/pylissom>`_ of the
+project. If Github is not rendering them, we leave these links at your disposal:
 
 `Linear modules <https://nbviewer.jupyter.org/github/hernanbari/pylissom/blob/master/notebooks/Linear_modules.ipynb>`_
 
 `Lissom modules <https://nbviewer.jupyter.org/github/hernanbari/pylissom/blob/master/notebooks/Lissom_modules.ipynb>`_
 
 `Optimizers <https://nbviewer.jupyter.org/github/hernanbari/pylissom/blob/master/notebooks/Optimizers.ipynb>`_
 
-`Orientation Maps and pylissom tools <https://nbviewer.jupyter.org/github/hernanbari/pylissom/blob/master/notebooks/Orientation_maps_and_tools.ipynb>`_
+`Orientation Maps and pylissom tools <https://nbviewer.jupyter
+.org/github/hernanbari/pylissom/blob/master/notebooks/Orientation_maps_and_tools.ipynb>`_
+
+The main features provided are:
+
+LISSOM's activation
+    Consisting of several layers following the :py:class:`torch.nn.Module` interface. Found in :ref:`nn_module`.
+
+LISSOM's hebbian learning mechanism and others
+    Implemented following the :py:class:`torch.optim.Optimizer` interface. Found in :ref:`optim`.
+
+Configuration and model building tools
+    Make it easy to track and change layer's hyperparameters. Based in the :py:mod:`configobj` and :py:mod:`yaml`
+    config libraries. Examples of config files and code can be found in :ref:`models` and :ref:`config`.
+
+Common Guassian stimuli for LISSOM experiments
+    Following the :py:class:`torch.utils.data.Dataset` interface. Uses the popular :py:mod:`scikit-image` and
+    :py:mod:`cv2` libs. Found in :ref:`datasets` and :ref:`stimuli`.
+
+Plotting helpers
+    For displaying LISSOM layers weights and activations mainly in Jupyter Notebooks. Uses :py:mod:`matplotlib`. Found
+    in :ref:`plotting`.
+
+Training objects for simplifying :py:mod:`torch` boilerplate.
+    Found in :ref:`pipeline`.