Merge pull request #470 from mv1388/cont-experiment-docu

Cont experiment docu
mv1388 · Apr 14, 2020 · fed6862 · fed6862
2 parents 75d8dfa + 7ab870e
commit fed6862
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/experiment.rst b/docs/source/experiment.rst
@@ -29,5 +29,5 @@ In general, :mod:`aitoolbox.experiment` helps the user with the following:
 
    experiment/result_package
    experiment/metrics
-   experiment/training_history
    experiment/experiment_save
+   experiment/training_history
diff --git a/docs/source/experiment/training_history.rst b/docs/source/experiment/training_history.rst
@@ -1,3 +1,10 @@
 Training History
 ================
 
+:class:`aitoolbox.experiment.training_history.TrainingHistory` is the util class which helps the user with tracking
+multiple performance metrics results during the model training process.
+
+Under the hood it is just a simple Python dict and it thus supports many of the standard dict operations and operators
+for easier use. However the ``TrainingHistory`` also offers a convenient API on top of the dict geared towards
+experiment performance tracking. It is mostly used under the hood of the torchtrain TrainLoops, but it can be
+easily also utilized as a standalone results tracker for any kind of ML experiments.