ScoutBot API
============

ScoutBot is the machine learning interface for the Wild Me Scout project.  This page specifies
the Python API to interact with all of the algorithms and machine learning models that have been
pretrained for inference in a production environment.

.. toctree::
   :maxdepth: 3

.. include:: overview.rst

.. include:: environment.rst

.. include:: onnx.rst

Tiles (TILE)
------------

.. automodule:: scoutbot.tile
   :members:
   :undoc-members:
   :show-inheritance:

Whole-Image Classifier (WIC)
----------------------------

.. automodule:: scoutbot.wic
   :members:
   :undoc-members:
   :show-inheritance:

Localizer (LOC)
---------------

.. automodule:: scoutbot.loc
   :members:
   :undoc-members:
   :show-inheritance:

Aggregation (AGG)
-----------------

.. automodule:: scoutbot.agg
   :members:
   :undoc-members:
   :show-inheritance:

Pipeline (PIPE)
---------------

.. automodule:: scoutbot.__init__
   :members:
   :undoc-members:
   :show-inheritance:

Utilities
---------

.. automodule:: scoutbot.utils
   :members:
   :undoc-members:
   :show-inheritance: