Merge pull request #462 from mv1388/add-doc-sections

General documentation structure
mv1388 · Apr 11, 2020 · 2f0693e · 2f0693e
2 parents 8b6c897 + 917106f
commit 2f0693e
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 2 deletions.
diff --git a/docs/source/cloud.rst b/docs/source/cloud.rst
@@ -1,3 +1,14 @@
 cloud
 =====
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Guides:
+
+   cloud/cloud_save
+   cloud/cloud_load
+   cloud/data_access
+   cloud/aws_ses
+
+
+Most of the functionality available both for AWS and Google Cloud.
diff --git a/docs/source/cloud/aws_ses.rst b/docs/source/cloud/aws_ses.rst
@@ -0,0 +1,4 @@
+AWS Simple Email Service
+========================
+
+
diff --git a/docs/source/cloud/cloud_load.rst b/docs/source/cloud/cloud_load.rst
@@ -0,0 +1,4 @@
+Downloading from Cloud
+======================
+
+about model load
diff --git a/docs/source/cloud/cloud_save.rst b/docs/source/cloud/cloud_save.rst
@@ -0,0 +1,4 @@
+Saving to Cloud
+===============
+
+combine model & results save
diff --git a/docs/source/cloud/data_access.rst b/docs/source/cloud/data_access.rst
@@ -0,0 +1,3 @@
+Data Access
+===========
+
diff --git a/docs/source/experiment.rst b/docs/source/experiment.rst
@@ -2,7 +2,10 @@ experiment
 ==========
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 1
    :caption: Guides:
 
    experiment/result_package
+   experiment/metrics
+   experiment/training_history
+   experiment/experiment_save
diff --git a/docs/source/experiment/experiment_save.rst b/docs/source/experiment/experiment_save.rst
@@ -0,0 +1,16 @@
+Experiment Saving
+=================
+
+
+
+Experiment Saver
+----------------
+
+
+Local Model Save
+----------------
+
+
+Local Results Save
+------------------
+
diff --git a/docs/source/experiment/metrics.rst b/docs/source/experiment/metrics.rst
@@ -0,0 +1,4 @@
+Result Metric
+=============
+
+
diff --git a/docs/source/experiment/training_history.rst b/docs/source/experiment/training_history.rst
@@ -0,0 +1,3 @@
+Training History
+================
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,6 +14,7 @@ AIToolbox - Model Training Framework for PyTorch
    torchtrain
    experiment
    cloud
+   nlp
 
 .. toctree::
    :maxdepth: 5
@@ -56,8 +57,9 @@ However, the greatest benefit of AIToolbox comes when all components are used to
 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:
+To learn more about components available in AIToolbox have a look at the corresponding documentation sections:
 
 * :doc:`torchtrain`
 * :doc:`experiment`
 * :doc:`cloud`
+* :doc:`nlp`
diff --git a/docs/source/nlp.rst b/docs/source/nlp.rst
@@ -0,0 +1,3 @@
+nlp
+===
+