.. habitat-api documentation master file, created by
   sphinx-quickstart on Tue Jun  4 13:03:57 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:github_url: https://github.com/facebookresearch/habitat-api

habitat-api documentation
=======================================

A modular high-level library to train embodied AI agents across a variety of tasks, environments, and simulators.

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

   tutorials/quickstart
   tutorials/habitat-sim-demo
   tutorials/habitat-api-demo
   tutorials/view-transform-warp

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

   habitat.core.env <core/env>
   habitat.core.embodied_task <core/embodied_task>
   habitat.core.dataset <core/dataset>
   habitat.core.simulator <core/simulator>
   habitat.core.vector_env <core/vector_env>
   habitat.Agent <core/agent>
   habitat.Benchmark <core/benchmark>


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

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