Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattdawkins committed Feb 5, 2018
1 parent 50f4bdd commit 2db706c
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 15 deletions.
2 changes: 1 addition & 1 deletion doc/manuals/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Contents:
example_links/visualizing_detections_in_gui
example_links/scoring_and_roc_generation
example_links/external_plugin_creation
KWIVER Manual <http://kwiver.readthedocs.io/en/latest/>
KWIVER Full Manual <http://kwiver.readthedocs.io/en/latest/>


.. |br| raw:: html
Expand Down
6 changes: 3 additions & 3 deletions examples/detector_pipelines/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Requirements
| run_lanl.sh/bat - VIAME_ENABLE_MATLAB

**************************************
Running the object detection exammples
**************************************
*************************************
Running the object detection examples
*************************************

Each run script contains 2 calls. A first ('source setup_viame.sh') which
runs a script configuring all paths required to run VIAME calls, and a second
Expand Down
6 changes: 3 additions & 3 deletions examples/detector_training/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

=====================
Detector Training API
=====================
==========================
Detector Training Examples
==========================

The common detector training API is used for training multiple object
detectors from the same input format for both experimentation and
Expand Down
27 changes: 22 additions & 5 deletions examples/image_and_video_search/README.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@

==============================================
Image and Video Search, Rapid Model Generation
==============================================
===============================
Image and Video Search Examples
===============================

This directory contains methods to accomplish two tasks:

|
| (a) Performing image searches on an archive of imagery or videos
| (b) Quickly training up detection models for new categories of objects
|
Only Linux and Mac are currently supported for running these examples.

********************
Image Archive Search
--------------------
********************

The "smqtk_on_chips" directory contains multiple methods for running image
queries on an image archive, including:

|
| (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.
|
This primarily uses the SMQTK toolkit and is designed for images, not videos.
A web-based GUI is provided which allows new queries based on an input query
image, and the refinement of results via iterative query refinement (IQR).
IQR generates an SVM classifier on user-nominated positive and negative
examples from the result set to refine results.


********************
Video Archive Search
--------------------
********************

Video archive search can be performed via a few methods. The default includes
a pipeline which generates object detections, tracks, and lastly temporal
Expand All @@ -38,3 +44,14 @@ table, or other). At query time, descriptors on a query image or video are
matched against the entries in this database. A default GUI (provided via
the VIVIA toolkit) is provided which has similar capabilities to the SMQTK
GUI, ie, search and IQR.


======================
Rapid Model Generation
======================

Rapid model generation can be performed in the same way as image and video search,
just saving out the resultant trained detection models after performing iterative
query refinement.

Additional documentation coming soon.
6 changes: 3 additions & 3 deletions examples/tracking_pipelines/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

=======================
Object Tracking Example
=======================
========================
Object Tracking Examples
========================

.. image:: http://www.viametoolkit.org/wp-content/uploads/2018/02/computed_track_example.png
:scale: 60
Expand Down

0 comments on commit 2db706c

Please sign in to comment.