.. OpenMixup documentation master file, created by
   sphinx-quickstart on Thu June 15 05:11:34 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OpenMixup's documentation!
=====================================

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   install.md
   get_started.md

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

   tutorials/0_config.md
   tutorials/1_new_dataset.md
   tutorials/2_data_pipeline.md
   tutorials/3_new_module.md
   tutorials/4_schedule.md
   tutorials/5_runtime.md
   tutorials/6_benchmarks.md

.. toctree::
   :maxdepth: 1
   :caption: Model Zoos

   model_zoos/Model_Zoo_selfsup.md
   model_zoos/Model_Zoo_semisup.md
   model_zoos/Model_Zoo_sup.md

.. toctree::
   :maxdepth: 1
   :caption: Awesome Mixup Methods

   awesome_mixups/Mixup_SL.md
   awesome_mixups/Mixup_SSL.md

.. toctree::
   :maxdepth: 1
   :caption: Awesome Self-supervised Learning Methods

   awesome_selfsup/MIM.md

.. toctree::
   :maxdepth: 1
   :caption: Notes

   changelog.md
   compatibility.md

.. toctree::
   :caption: Switch Language

   switch_language.md

.. toctree::
   :caption: API Reference

   api.rst




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

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