.. xaitk-saliency documentation master file, created by
   sphinx-quickstart on Mon Apr 26 20:04:34 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to xaitk-saliency's documentation!
==========================================

Welcome to the documentation for xaitk-saliency. As part of the Explainable
AI Toolkit (XAITK), xaitk-saliency is an open source, explainable AI framework for visual saliency algorithm interfaces
and implementations, built for analytics and autonomy applications.
The xaitk-saliency package provides saliency algorithms for a wide range of image understanding
tasks, including image classification, image similarity, object detection, and reinforcement
learning. The current list of supported saliency algorithms can be found in :ref:`Saliency
Algorithms`.

This documentation is structured to provide you with straightforward and practical instructions and examples, so that
you can effectively leverage the toolkit to enhance the robustness and reliability of your computer vision applications
in facing real-world challenges.

.. :auto acknowledgment:

Acknowledgment
--------------

This material is based upon work supported by the Chief Digital and Artificial Intelligence Office under Contract No.
519TC-23-9-2032. The views and conclusions contained herein are those of the author(s) and should not be interpreted as
necessarily representing the official policies or endorsements, either expressed or implied, of the U.S. Government.

.. :auto acknowledgment:

Documentation Contents:
=======================


.. toctree::
   :maxdepth: 1
   :caption: Quick Start

   installation
   getting_started

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   examples/OcclusionSaliency.ipynb
   examples/DRISE.ipynb

.. toctree::
   :maxdepth: 1
   :caption: Explanation

   xaitk_explanation
   design

.. toctree::
   :maxdepth: 1
   :caption: How-To

   xaitk_how_to_topics
   review_process
   release_process

.. toctree::
   :maxdepth: 1
   :caption: Reference

   interfaces
   implementations
   faq
   glossary
   release_notes
   style_sheet



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`