Updated Read the Docs Documentation

.readthedocs.yml

@@ -17,3 +17,6 @@ python:
       path: .
       extra_requirements:
         - memtorch
+
+submodules:
+  include: all

docs/memtorch.bh.memristor.rst

@@ -1,21 +1,48 @@
 memtorch.bh.memristor
-=============================
-Submodule containing various behavioural memristor models, which extend :ref:`base-class-label`.
+=====================
+Submodule containing various behavioral memristor models, that extend :ref:`base-class-label`.
 
-.. _base-class-label:
+.. automodule:: memtorch.bh.memristor.window
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 memtorch.bh.memristor.Memristor
---------------------------------------
+-------------------------------
 
 .. automodule:: memtorch.bh.memristor.Memristor
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.bh.memristor.LinearIonDrift
--------------------------------------------
+------------------------------------
 
 .. automodule:: memtorch.bh.memristor.LinearIonDrift
    :members:
    :undoc-members:
    :show-inheritance:
+
+memtorch.bh.memristor.VTEAM
+---------------------------
+
+.. automodule:: memtorch.bh.memristor.VTEAM
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.memristor.Data_Driven
+---------------------------------
+
+.. automodule:: memtorch.bh.memristor.Data_Driven
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.memristor.Stanford_PKU
+----------------------------------
+
+.. automodule:: memtorch.bh.memristor.Stanford_PKU
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/memtorch.bh.nonideality.rst

@@ -1,29 +1,36 @@
 memtorch.bh.nonideality
-===============================
+=======================
 Submodule containing various models, which can be used to introduce non-idealities.
 
 memtorch.bh.nonideality.NonIdeality
-------------------------------------------
+-----------------------------------
 
 .. automodule:: memtorch.bh.nonideality.NonIdeality
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.bh.nonideality.FiniteConductanceStates
-------------------------------------------------------
+-----------------------------------------------
 Used to model a finite number of conductance states.
 
 .. automodule:: memtorch.bh.nonideality.FiniteConductanceStates
    :members:
    :undoc-members:
    :show-inheritance:
 
-memtorch.bh.nonideality.Variability
-------------------------------------------
-Used to model device-device variability.
+memtorch.bh.nonideality.DeviceFaults
+------------------------------------
 
-.. automodule:: memtorch.bh.nonideality.Variability
+.. automodule:: memtorch.bh.nonideality.DeviceFaults
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.nonideality.NonLinear
+---------------------------------
+
+.. automodule:: memtorch.bh.nonideality.NonLinear
    :members:
    :undoc-members:
    :show-inheritance:

docs/memtorch.bh.rst

@@ -1,16 +1,52 @@
 memtorch.bh
-===================
-Submodule containing various behavioural models.
+===========
+Submodule containing various behavioral models.
 
 .. toctree::
-
    memtorch.bh.memristor
    memtorch.bh.nonideality
 
-memtorch.bh.Crossbar
----------------------------
+memtorch.bh.crossbar.Crossbar
+-----------------------------
+Class used to model memristor crossbars.
+
+.. automodule:: memtorch.bh.crossbar.Crossbar
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.crossbar.Tile
+-------------------------
+Class used to create modular crossbar tiles to represent 2D matrices.
+
+.. automodule:: memtorch.bh.crossbar.Tile
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.crossbar.Program
+----------------------------
+Methods to program (alter) the conductance devices within a crossbar.
+
+.. automodule:: memtorch.bh.crossbar.Program
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.Quantize
+--------------------
+Wrapper for the pytorch-playground quant.py script.
+
+.. automodule:: memtorch.bh.Quantize
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.StochasticParameter
+-------------------------------
+Methods to model stochastic parameters.
 
-.. automodule:: memtorch.bh.Crossbar
+.. automodule:: memtorch.bh.StochasticParameter
    :members:
    :undoc-members:
    :show-inheritance:

docs/memtorch.bh.window

@@ -0,0 +1,23 @@
+memtorch.bh.memristor.window.Biolek
+-----------------------------------
+
+.. automodule:: memtorch.bh.memristor.window.Biolek
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.memristor.window.Jogelkar
+-------------------------------------
+
+.. automodule:: memtorch.bh.memristor.window.Jogelkar
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+memtorch.bh.memristor.window.Prodromakis
+----------------------------------------
+
+.. automodule:: memtorch.bh.memristor.window.Prodromakis
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/memtorch.map.rst

@@ -1,17 +1,19 @@
 memtorch.map
-====================
+============
 Submodule containing various mapping algorithms.
 
 memtorch.map.Module
------------------------------
+-------------------
+Methods to determine relationships between a memristive crossbar and the output for a given memristive module.
 
 .. automodule:: memtorch.map.Module
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.map.Parameter
------------------------------
+----------------------
+Methods to naively map network parameters to memristive device conductance's.
 
 .. automodule:: memtorch.map.Parameter
    :members:

docs/memtorch.mn.rst

@@ -1,37 +1,47 @@
 memtorch.mn
-===================
+===========
 torch.nn equivalent submodule.
 
 memtorch.mn.Module
--------------------------
+------------------
+Methods to convert and tune torch.nn models.
+
 .. automodule:: memtorch.mn.Module
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.mn.Linear
--------------------------
+------------------
+torch.nn.Linear equivalent.
+
 .. automodule:: memtorch.mn.Linear
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.mn.Conv1d
--------------------------
+------------------
+torch.nn.Conv1d equivalent.
+
 .. automodule:: memtorch.mn.Conv1d
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.mn.Conv2d
--------------------------
+------------------
+torch.nn.Conv2d equivalent.
+
 .. automodule:: memtorch.mn.Conv2d
    :members:
    :undoc-members:
    :show-inheritance:
 
 memtorch.mn.Conv3d
--------------------------
+------------------
+torch.nn.Conv3d equivalent.
+
 .. automodule:: memtorch.mn.Conv3d
    :members:
    :undoc-members:

docs/memtorch.rst

@@ -1,5 +1,5 @@
 Python API
-================
+==========
 .. toctree::
 
    memtorch.bh

memtorch/bh/StochasticParameter.py

@@ -5,7 +5,7 @@
 import copy
 
 def StochasticParameter(distribution=torch.distributions.normal.Normal, min=0, max=float('Inf'), function=True, **kwargs):
-    """Method to model a stochatic parameter.
+    """Method to model a stochastic parameter.
 
     Parameters
     ----------