Update docs

VIAME · Feb 5, 2018 · 3be6649 · 3be6649
1 parent bfe663d
commit 3be6649
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 9 deletions.
diff --git a/doc/manuals/example_links/image_and_video_search.rst b/doc/manuals/example_links/image_and_video_search.rst
@@ -1 +1,3 @@
 .. include:: ../../../examples/image_and_video_search/README.rst
+.. include:: ../../../examples/image_and_video_search/smqtk_on_chips/README.rst
+.. include:: ../../../examples/image_and_video_search/video_ingest/README.rst
diff --git a/examples/README.rst b/examples/README.rst
@@ -46,4 +46,4 @@ Detector Evaluation
 .. image:: http://www.viametoolkit.org/wp-content/uploads/2018/02/scoring-2.png
    :scale: 50
    :align: center
-   :target: https://github.com/Kitware/VIAME/tree/master/examples/scoring_and_roc_generatio
+   :target: https://github.com/Kitware/VIAME/tree/master/examples/scoring_and_roc_generation
diff --git a/examples/image_and_video_search/smqtk_on_chips/README.rst b/examples/image_and_video_search/smqtk_on_chips/README.rst
@@ -1,23 +1,29 @@
+
+************************
 Image Search Using SMQTK
-------------------------
+************************
 
 This folder contains examples covering image search on top of an archive of images. 
 
-It currently requires Linux or Mac systems, Windows is not fully supported. 
-
-Building and running this examples requires: 
+|
+| Building and running this examples requires: 
 |
 |  (a) The python packages: numpy 
-|  (b) A VIAME build with VIAME_ENABLE_SMQTK turned ON 
-|  (c) An installation of MongoDB to run the web client 
-|  (d) Optionally: VIAME_ENABLE_YOLO flags to run the detector example 
+|  (b) Linux or Mac systems, Windows is not fully supported. 
+|  (c) A VIAME build with the following flags enabled:
+|        - VIAME_ENABLE_SMQTK
+|        - VIAME_ENABLE_CAFFE
+|        - VIAME_ENABLE_CUDA (Optional, but desired for performance)
+|        - VIAME_ENABLE_YOLO (Optional, for detector ingest example)
+|  (d) An installation of MongoDB to run the web client 
 |
-The system can either be configured to perform queries via: 
+| The system can either be configured to perform queries via: 
 |
 | (a) Indexing descriptors around each full input image as-is.
 | (b) Tiling up each input image into fixed-size tiles. 
 | (c) Indexing descriptors around detections generated by arbitrary detectors. 
 |
+
 First, reset_database.sh should be called to initialize a new database. 
 
 Next, depending on which indexing paradigm you are using, one of the 3 ingesting shell
@@ -26,3 +32,9 @@ scripts can be called.
 Which ingesting paradigm you want to use depends on a few factors: does your object
 take up the entire image? Use (a). Are your object(s) a fixed known size in your image?
 Use (b). Are your objects multiple scales? Use (c).
+
+After ingesting data, you want to launch the web-GUI service (launch_gui_backend.sh), and connect
+to the GUI via going to the default website 'http://0.0.0.0:5000/' if you didn't change any
+hosting settings. The default GUI log in is username: demo, password: demo after which
+you can log in, perform image queries, and iterative refinement on the results to generate
+an improved model for your query.
diff --git a/examples/image_and_video_search/video_ingest/README.rst b/examples/image_and_video_search/video_ingest/README.rst
@@ -1,3 +1,8 @@
+
+************************
+Video Search using VIAME
+************************
+
 This folder contains an example for video search. 
 |
 | WARNING: This example is a work in progress, and should only be attempted