mirror of
https://github.com/open-mmlab/mmselfsup.git
synced 2025-06-03 14:59:38 +08:00
bbdf670d00
* [Fix]: Set qkv bias to False for cae and True for mae (#303) * [Fix]: Add mmcls transformer layer choice * [Fix]: Fix transformer encoder layer bug * [Fix]: Change UT of cae * [Feature]: Change the file name of cosine annealing hook (#304) * [Feature]: Change cosine annealing hook file name * [Feature]: Add UT for cosine annealing hook * [Fix]: Fix lint * read tutorials and fix typo (#308) * [Fix] fix config errors in MAE (#307) * update readthedocs algorithm readme (#310) * [Docs] Replace markdownlint with mdformat (#311) * Replace markdownlint with mdformat to avoid installing ruby * fix typo * add 'ba' to codespell ignore-words-list * Configure Myst-parser to parse anchor tag (#309) * [Docs] rewrite install.md (#317) * rewrite the install.md * add faq.md * fix lint * add FAQ to README * add Chinese version * fix typo * fix format * remove modification * fix format * [Docs] refine README.md file (#318) * refine README.md file * fix lint * format language button * rename getting_started.md * revise index.rst * add model_zoo.md to index.rst * fix lint * refine readme Co-authored-by: Jiahao Xie <52497952+Jiahao000@users.noreply.github.com> * [Enhance] update byol models and results (#319) * Update version information (#321) Co-authored-by: Yuan Liu <30762564+YuanLiuuuuuu@users.noreply.github.com> Co-authored-by: Yi Lu <21515006@zju.edu.cn> Co-authored-by: RenQin <45731309+soonera@users.noreply.github.com> Co-authored-by: Jiahao Xie <52497952+Jiahao000@users.noreply.github.com>
77 lines
1.3 KiB
ReStructuredText
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`
|