Merge pull request #459 from mv1388/documentation-writing

Docu Index page setup and torchtrain docs structure
mv1388 · Apr 11, 2020 · fa13df1 · fa13df1
2 parents ddd7f7a + 15ef490
commit fa13df1
Show file tree

Hide file tree

Showing 14 changed files with 107 additions and 10 deletions.
diff --git a/build_package.sh b/build_package.sh
@@ -29,5 +29,5 @@ git add -A dist/
 
 
 if [ "$build_documentation" == true ]; then
-    ./doc_build.sh
+    ./doc_build.sh --clean
 fi
diff --git a/doc_build.sh b/doc_build.sh
@@ -2,6 +2,28 @@
 
 source activate py36
 
+clean_build=false
+
+while [[ $# -gt 0 ]]; do
+key="$1"
+
+case $key in
+    -c|--clean)
+    clean_build=true
+    shift 1 # past argument value
+    ;;
+    *)    # unknown option
+    echo "Don't know the argument"
+    ;;
+esac
+done
+
+
 #sphinx-apidoc -f --separate --module-first -t docs/source/_templates -o docs/source/api aitoolbox
 
-sphinx-build -b html docs/source docs/build
+if [ "$clean_build" == false ]; then
+    sphinx-build -b html docs/source docs/build
+else
+    sphinx-build -Ea -b html docs/source docs/build
+fi
+
diff --git a/docs/source/api/api_aitoolbox.rst b/docs/source/api/api_aitoolbox.rst
@@ -1,5 +1,5 @@
-aitoolbox API
-=================
+aitoolbox
+=========
 
 .. automodule:: aitoolbox
    :members:

diff --git a/docs/source/cloud.rst b/docs/source/cloud.rst
@@ -1,3 +1,3 @@
-Cloud
+cloud
 =====
 
diff --git a/docs/source/experiment.rst b/docs/source/experiment.rst
@@ -1,3 +1,3 @@
-Experiment Tracking
-===================
+experiment
+==========
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,21 +4,33 @@
    contain the root `toctree` directive.
 
 AIToolbox - Model Training Framework for PyTorch
-===================================================================================
+================================================
 
 .. toctree::
    :maxdepth: 5
-   :caption: Contents:
+   :caption: Components:
    :hidden:
 
    torchtrain
    experiment
    cloud
+
+.. toctree::
+   :maxdepth: 5
+   :caption: Examples:
+   :hidden:
+
    examples
+
+.. toctree::
+   :maxdepth: 5
+   :caption: API:
+   :hidden:
+
    api/api_aitoolbox
 
 
-A framework which helps you train deep learning models in PyTorch and quickly iterate experiments.
+AIToolbox is a framework which helps you train deep learning models in PyTorch and quickly iterate experiments.
 It hides the repetitive technicalities of training the neural nets and frees you to focus on interesting part of
 devising new models. In essence, it offers a keras-style train loop abstraction which can be used for higher
 level training process while still allowing the manual control on the lower level when desired.
@@ -29,3 +41,23 @@ These can be stored both locally or on AWS S3 (Google Cloud Storage in beta) whi
 when training on the GPU instance on AWS. Instance can be automatically shut down when training is finished and all
 the results are safely stored on S3.
 
+
+Main Components
+---------------
+
+AIToolbox consists of three main user-facing components:
+
+* :mod:`aitoolbox.torchtrain` - PyTorch train loop engine
+* :mod:`aitoolbox.experiment` - experiment tracking
+* :mod:`aitoolbox.cloud` - cloud operations for *AWS* and *Google Cloud*
+
+All three AIToolbox components can be used independently when only some subset of functionality is desired in a project.
+However, the greatest benefit of AIToolbox comes when all components are used together in unison in order to ease
+the process of PyTorch model training and experiment tracking as much as possible.
+Most of this top-level API is exposed to the user via the functionality implemented in :mod:`aitoolbox.torchtrain`.
+
+To learn more about each of AIToolbox components have a look at the corresponding documentation sections:
+
+* :doc:`torchtrain`
+* :doc:`experiment`
+* :doc:`cloud`
diff --git a/docs/source/torchtrain.rst b/docs/source/torchtrain.rst
@@ -1,4 +1,12 @@
 torchtrain
 ==========
 
+.. toctree::
+   :maxdepth: 5
+   :hidden:
 
+   torchtrain/train_loop
+   torchtrain/model
+   torchtrain/callbacks
+   torchtrain/parallel
+   torchtrain/developer
diff --git a/docs/source/torchtrain/callbacks.rst b/docs/source/torchtrain/callbacks.rst
@@ -0,0 +1,4 @@
+Callbacks
+=========
+
+
diff --git a/docs/source/torchtrain/dev/message_passing.rst b/docs/source/torchtrain/dev/message_passing.rst
@@ -0,0 +1,4 @@
+Message Passing Service
+=======================
+
+
diff --git a/docs/source/torchtrain/dev/model_prediction_store.rst b/docs/source/torchtrain/dev/model_prediction_store.rst
@@ -0,0 +1,4 @@
+Model Prediction Store
+======================
+
+
diff --git a/docs/source/torchtrain/developer.rst b/docs/source/torchtrain/developer.rst
@@ -0,0 +1,9 @@
+Developer Guide
+===============
+
+.. toctree::
+   :maxdepth: 5
+   :hidden:
+
+   dev/message_passing
+   dev/model_prediction_store
diff --git a/docs/source/torchtrain/model.rst b/docs/source/torchtrain/model.rst
@@ -0,0 +1,6 @@
+TTModel
+=======
+
+Torchtrain Model, TTModel for short
+
+
diff --git a/docs/source/torchtrain/parallel.rst b/docs/source/torchtrain/parallel.rst
@@ -0,0 +1,4 @@
+Multi-GPU training
+==================
+
+
diff --git a/docs/source/torchtrain/train_loop.rst b/docs/source/torchtrain/train_loop.rst
@@ -0,0 +1,4 @@
+Train Loop
+==========
+
+