.. _index:

API Documentation
=================

Click below for documentation specific to each module:

.. toctree::
   :maxdepth: 1

   core
   utils
   visualize


Core
----

The :ref:`core` module contains the central classes of the package: Dataset,
DataLoader, and Model. These are used to read in a labeled dataset and train
a functioning object detection model.


Utils
-----

The :ref:`utils` module contains a variety of useful helper functions. With
it, you can read in images, convert XML files into CSV files, apply standard
transforms to images, and more.


Visualize
---------

The :ref:`visualize` module is used to display labeled images, plot
predictions, and run object detection on videos.