robomimic/docs/index.rst

.. robomimic documentation master file, created by
   sphinx-quickstart on Wed Apr  7 00:03:09 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to robomimic's documentation!
=====================================

.. toctree::
   :maxdepth: 1
   :caption: Introduction

   introduction/overview
   introduction/installation
   introduction/implemented_algorithms
   introduction/getting_started

.. toctree::
   :maxdepth: 1
   :caption: Datasets

   datasets/overview
   datasets/robomimic_v0.1
   datasets/mimicgen
   datasets/robosuite
   datasets/d4rl
   datasets/momart
   datasets/roboturk_pilot

.. toctree::
   :maxdepth: 1
   :caption: Pretrained Models

   model_zoo/robomimic_v0.1

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

   tutorials/configs
   tutorials/viewing_results
   tutorials/hyperparam_scan
   tutorials/reproducing_experiments
   tutorials/dataset_contents
   tutorials/multi_dataset_training
   tutorials/training_transformers
   tutorials/training_diffusion_policy
   tutorials/using_pretrained_models
   tutorials/observations
   tutorials/action_configs
   tutorials/language_conditioning
   tutorials/pretrained_representations
   tutorials/custom_algorithms
   tutorials/tensor_collections

.. toctree::
   :maxdepth: 1
   :caption: Modules

   modules/overview
   modules/dataset
   modules/algorithms
   modules/models
   modules/configs
   modules/environments
   modules/utils

.. toctree::
   :maxdepth: 4
   :caption: Source API

   api/robomimic

.. toctree::
   :maxdepth: 1
   :caption: Miscellaneous

   miscellaneous/troubleshooting
   miscellaneous/contributing
   miscellaneous/team
   miscellaneous/acknowledgments
   miscellaneous/references

.. toctree::
   :maxdepth: 1
   :caption: Previous Versions

   versions/v0.4
   versions/v0.3
   versions/v0.2


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

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