Merge pull request #283 from Living-with-machines/rw_docs

Update about docs
maps-as-data · Oct 31, 2023 · dfdbd1f · dfdbd1f
2 parents 2335e81 + ac00727
commit dfdbd1f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/docs/source/About.rst b/docs/source/About.rst
@@ -62,3 +62,26 @@ What skills/knowledge will I need to use MapReader?
 * Basic understanding of how to use your terminal
 * Basic python
 * Basic understanding of machine learning and computer vision (CV) methodology
+
+What are the inputs and outputs of each stage in the MapReader pipeline?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Download
+^^^^^^^^^
+.. image:: figures/in_out_download.png
+    :width: 400px
+
+Load
+^^^^^
+.. image:: figures/in_out_load.png
+    :width: 400px
+
+Annotate
+^^^^^^^^^
+.. image:: figures/in_out_annotate.png
+    :width: 400px
+
+Classify (Train and Predict)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. image:: figures/in_out_classify.png
+    :width: 400px
diff --git a/docs/source/User-guide/Post-process.rst b/docs/source/User-guide/Post-process.rst
@@ -1,2 +1,4 @@
 Post-process
 =============
+
+TBC
diff --git a/docs/source/figures/pipeline_explained.png b/docs/source/figures/pipeline_explained.png