mmselfsup/docs/en/index.rst

64 lines
1007 B
ReStructuredText
Raw Normal View History

2021-12-15 19:06:36 +08:00
.. 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
overview.md
Bump version to v0.9.1 (#322) * [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>
2022-06-01 09:59:05 +08:00
get_started.md
2021-12-15 19:06:36 +08:00
.. toctree::
:maxdepth: 2
:caption: User Guides
2021-12-15 19:06:36 +08:00
user_guides/index.rst
2021-12-15 19:06:36 +08:00
.. toctree::
:maxdepth: 2
:caption: Advanced Guides
2021-12-15 19:06:36 +08:00
advanced_guides/index.rst
2021-12-15 19:06:36 +08:00
.. toctree::
:maxdepth: 1
:caption: Model Zoo
2021-12-15 19:06:36 +08:00
model_zoo.md
2021-12-15 19:06:36 +08:00
.. toctree::
:maxdepth: 1
:caption: Migration
2021-12-15 19:06:36 +08:00
migration.md
2021-12-15 19:06:36 +08:00
.. toctree::
:caption: API Reference
api.rst
.. toctree::
:maxdepth: 1
:caption: Notes
contribution_guide.md
changelog.md
faq.md
2021-12-15 19:06:36 +08:00
.. toctree::
:caption: Switch Language
2021-12-15 19:06:36 +08:00
switch_language.md
2021-12-15 19:06:36 +08:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
2021-12-15 19:06:36 +08:00
* :ref:`search`