Merge pull request #31 from GilesStrong/new_live

New live
GilesStrong · Feb 12, 2020 · 8675b72 · 8675b72
2 parents 1ed79d7 + b3d7a05
commit 8675b72
Show file tree

Hide file tree

Showing 16 changed files with 2,669 additions and 2,454 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,23 +2,38 @@
 
 ## Important changes
 
+- New live plot for losses during training (`MetricLogger`):
+    - Provides additional information
+    - Only updates after every epoch (previously every subepoch) reducing training times
+    - Nicer appearance and automatic log scale for y-axis
+
 ## Breaking
 
 ## Additions
 
+- New live plot for losses during training (`MetricLogger`):
+    - Provides additional information
+    - Only updates after every epoch (previously every subepoch) reducing training times
+    - Nicer appearance and automatic log scale for y-axis
+
 ## Removals
 
 ## Fixes
 
+- Fixed error in documentation which removed the ToC for the nn module
+
 ## Changes
 
 ## Depreciations
 
+- `plots` argument in `fold_train_ensemble`. The plots argument is now depreciated and ignored. Loss history will always be shown, lr history will no longer be shown separately, and live feedback is now controlled by the four live_fdbk arguments. This argument will be removed in V0.6.
+
 ## Comments
 
 # V0.5 - The Gradient Must Flow
 
 ## Important changes
+
 - Added support for processing and embedding of matrix data
     - `MultiHead` to allow the use of multiple head blocks to handle input data containing flat and matrix inputs
     - `AbsMatrixHead` abstract class for head blocks designed to process matrix data

diff --git a/docs/source/lumin.nn.models.rst b/docs/source/lumin.nn.models.rst
@@ -6,6 +6,7 @@ Subpackages
 
 .. toctree::
    :maxdepth: 1
+
    lumin.nn.models.blocks
    lumin.nn.models.layers
 

diff --git a/docs/source/lumin.nn.rst b/docs/source/lumin.nn.rst
@@ -6,6 +6,7 @@ Subpackages
 
 .. toctree::
    :maxdepth: 1
+
    lumin.nn.callbacks
    lumin.nn.data
    lumin.nn.ensemble

diff --git a/docs/source/lumin.nn.training.rst b/docs/source/lumin.nn.training.rst
@@ -12,6 +12,14 @@ lumin.nn.training.fold\_train module
    :undoc-members:
    :show-inheritance:
 
+lumin.nn.training.metric\_logger module
+---------------------------------------
+
+.. automodule:: lumin.nn.training.metric_logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 Module contents
 ---------------

diff --git a/docs/source/lumin.rst b/docs/source/lumin.rst
@@ -6,6 +6,7 @@ Subpackages
 
 .. toctree::
    :maxdepth: 1
+
    lumin.data_processing
    lumin.evaluation
    lumin.inference

diff --git a/examples/Advanced_Model_Building.ipynb b/examples/Advanced_Model_Building.ipynb
diff --git a/examples/Binary_Classification.ipynb b/examples/Binary_Classification.ipynb
diff --git a/examples/Classification_of_earnings.ipynb b/examples/Classification_of_earnings.ipynb
diff --git a/examples/Feature_Selection.ipynb b/examples/Feature_Selection.ipynb
@@ -41,7 +41,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# !pip install fastprogress==0.1.21 lumin\n",
+    "# !pip install lumin\n",
     "# !git clone https://github.com/SauceCat/PDPbox.git && cd PDPbox && pip install -e ."
    ]
   },