Migrate documentation from worddoc

henrylao · Dec 1, 2021 · ecfe6b0 · ecfe6b0
1 parent b9a6689
commit ecfe6b0
Show file tree

Hide file tree

Showing 11 changed files with 92 additions and 31 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,11 +1,23 @@
 .. MSCG Net documentation master file, created by
- sphinx-quickstart on Wed Nov 24 07:25:06 2021.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+sphinx-quickstart on Wed Nov 24 07:25:06 2021.
+You can adapt this file completely to your liking, but it should at least
+contain the root `toctree` directive.
 
 MSCG-Net Documentation
 ====================================
-
+This project was designed to adapt the work of Liu et al. and
+convert it to a mobile device which would allow for
+in-the-field processing of images and much faster response
+time and lower network requirements versus a computing cluster
+that would typically be utilized for these sorts of tasks. While
+working on this adaptation, we utilized two separate methods to
+ensure flexibility of classification: a local method powered entirely
+by the Android device for those phones with the computing capacity
+to spare, and a REST-based method designed to take advantage of
+existing networks and send the image back to a computer for offsite
+processing, storage, and evaluation. The following paper
+describes implementation, downloading and running instructions,
+screenshots, and finally comments/critiques.
 
 
 
@@ -25,23 +37,34 @@ Development
 
  ./quickstart
  ./installation
- ./android
  ./configuring
  ./development
  ./changelog
 
+.. toctree::
+ :caption: MSCG-Net Android Documentation
+ :maxdepth: 2
+ :titlesonly:
+ :hidden:
+
+ mscg/android/overview
+ mscg/android/demo
+ mscg/android/preprocessing
+ mscg/android/models
+ mscg/android/deployment
+
 .. toctree::
  :caption: CLI Documentation
  :maxdepth: 2
  :hidden:
 
  mscg/cli/cli_overview
- mscg/cli/cli_installation
+ mscg/cli/installation
  mscg/cli/cli_usage
 
 
 .. toctree::
- :caption: API Documentation
+ :caption: MSCG-Net API Documentation
  :maxdepth: 2
  :titlesonly:
  :hidden:
@@ -54,3 +77,5 @@ Development
  mscg/api/tables
 
 
+
+
diff --git a/docs/source/android.rst → docs/source/mscg/android/demo.rst b/docs/source/android.rst → docs/source/mscg/android/demo.rst
@@ -1,5 +1,3 @@
 =====================================
-Android
+Demo
 =====================================
-
-
diff --git a/docs/source/mscg/android/deployment.rst b/docs/source/mscg/android/deployment.rst
@@ -0,0 +1,3 @@
+=====================================
+Deployment
+=====================================
diff --git a/docs/source/mscg/android/models.rst b/docs/source/mscg/android/models.rst
@@ -0,0 +1,3 @@
+=====================================
+Models
+=====================================
diff --git a/docs/source/mscg/cli/cli_overview.rst → docs/source/mscg/android/overview.rst b/docs/source/mscg/cli/cli_overview.rst → docs/source/mscg/android/overview.rst
diff --git a/docs/source/mscg/android/preprocessing.rst b/docs/source/mscg/android/preprocessing.rst
@@ -0,0 +1,3 @@
+=====================================
+Preprocessing
+=====================================
diff --git a/docs/source/mscg/api/tables.rst b/docs/source/mscg/api/tables.rst
@@ -1,6 +1,10 @@
-=====================================
-Tables of Results
-=====================================
+==========================================================================
+ Tables of Results: Agriculture Vision 2021
+==========================================================================
+
+==========================================================================
+ Tables of Results: Agriculture Vision 2020
+==========================================================================
 
 Results Summary
 ---------------

diff --git a/docs/source/mscg/api/utilities.rst b/docs/source/mscg/api/utilities.rst
@@ -2,38 +2,47 @@
 Utilities
 =====================================
 
-Checkpoint
--------------
-Hello world
-Hello world
-Hello world
+.. automodule:: utils.__init__
+ :members:
+ :special-members: __init__, __name__
+
 
+Tracing
+=====================================
+
+Utility functions for model debugging, setup and loading
+
+**Checkpoint**
+---------------
 .. automodule:: utils.trace.checkpoint
  :members:
 
-Loss
--------------
-.. automodule:: utils.metrics.loss
+**GPU**
+---------------
+.. automodule:: utils.trace.gpu
  :members:
- :special-members: __init__, __name__
 
-Configuration
--------------
-.. automodule:: utils.config
+**Logger**
+---------------
+.. automodule:: utils.trace.logger
  :members:
 
-Logger
+Metrics
 -------------
-.. automodule:: utils.trace.logger
+
+**Loss**
+----------
+.. automodule:: utils.metrics.loss
  :members:
+ :special-members: __init__, __name__
 
-Optimizer
--------------
+**Optimizer**
+--------------------------
 .. automodule:: utils.metrics.optimizer
  :members:
 
-Learning Rate
--------------
+**Learning Rate**
+--------------------------
 .. automodule:: utils.metrics.lr
  :members:
 
@@ -47,5 +56,18 @@ Visual
 .. automodule:: utils.data.visual
  :members:
 
+Mobile Conversion
+====================
+
+**Android**
+-------------
+.. automodule:: utils.export.android
+ :members:
+
 
+Configuration
+-------------
+.. automodule:: utils.config
+ :members:
+ :special-members: __init__, __name__
 
diff --git a/docs/source/mscg/cli/cli_installation.rst → docs/source/mscg/cli/installation.rst b/docs/source/mscg/cli/cli_installation.rst → docs/source/mscg/cli/installation.rst
diff --git a/docs/source/mscg/cli/overview.rst b/docs/source/mscg/cli/overview.rst
@@ -0,0 +1,3 @@
+=====================================
+Overview
+=====================================
diff --git a/docs/source/mscg/cli/cli_usage.rst → docs/source/mscg/cli/usage.rst b/docs/source/mscg/cli/cli_usage.rst → docs/source/mscg/cli/usage.rst