mmselfsup/docs/en/index.rst

77 lines
1.3 KiB
ReStructuredText

.. MMSelfSup documentation master file, created by
sphinx-quickstart on Thu Dec 9 15:11:34 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to MMSelfSup's documentation!
=====================================
.. toctree::
:maxdepth: 1
:caption: Get Started
install.md
prepare_data.md
get_started.md
model_zoo.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: Algorithms
algorithms/byol.md
algorithms/deep.md
algorithms/dense.md
algorithms/moco.md
algorithms/npid.md
algorithms/odc.md
algorithms/rl.md
algorithms/rp.md
algorithms/simclr.md
algorithms/ss.md
algorithms/swav.md
algorithms/mocov3.md
algorithms/mae.md
algorithms/simmim.md
algorithms/barlowtwins.md
algorithms/cae.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`