mmyolo/docs/en/index.rst

120 lines
2.7 KiB
ReStructuredText
Raw Normal View History

2022-09-18 10:11:55 +08:00
Welcome to MMYOLO's documentation!
=======================================
You can switch between Chinese and English documents in the top-right corner of the layout.
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 2
2022-09-18 10:11:55 +08:00
:caption: Get Started
get_started/overview.md
get_started/dependencies.md
get_started/installation.md
get_started/15_minutes_object_detection.md
get_started/15_minutes_rotated_object_detection.md
get_started/15_minutes_instance_segmentation.md
get_started/article.md
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 2
:caption: Recommended Topics
recommended_topics/contributing.md
recommended_topics/model_design.md
recommended_topics/algorithm_descriptions/index.rst
[Docs] Add an ionogram example in MMYOLO application (#643) * [Fix] fix the config link for rtmdet_tiny * fir the lint * upload configs * [Docs]Add doc for application examples * [Doc] fix h1 title for ionogram_detection.md * [Fix] update doc links for project/misc/ * Update links for application_examples in README * Update links for application_examples in README * Fix the bad commit caused by a mistake merge. * Fix unnecessary modification on Table of Contents * Add description of dataset preparation * Add description of dataset preparation * Update dataset analysis and pipeline visualization * fix line too long * Update rtmdet_s in the benchmark * fix typo in the doc * Replace local ckpt path with url * Update file tree, check out for spaces * Beautify configs * Beautify configs * Add introduction of annotation tool * Update rtmdet benchmark * Update rtmdet configs * Fix typo * Add English doc * Minor revisio * Fix typo * Revision - check labels Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - sentence structure Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - fix typo Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - parameters and FLOPs Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - replace flops with FLOPs Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - enhance readability Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - fix typo Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - correct grammatical errors Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - enhance Co-authored-by: Range King <RangeKingHZ@gmail.com> --------- Co-authored-by: Range King <RangeKingHZ@gmail.com>
2023-03-13 11:29:37 +08:00
recommended_topics/application_examples/index.rst
recommended_topics/replace_backbone.md
recommended_topics/complexity_analysis.md
recommended_topics/labeling_to_deployment_tutorials.md
recommended_topics/visualization.md
recommended_topics/deploy/index.rst
recommended_topics/troubleshooting_steps.md
recommended_topics/mm_basics.md
recommended_topics/dataset_preparation.md
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 2
:caption: Common Usage
common_usage/resume_training.md
common_usage/syncbn.md
common_usage/amp_training.md
common_usage/ms_training_testing.md
common_usage/tta.md
common_usage/plugins.md
common_usage/freeze_layers.md
common_usage/output_predictions.md
common_usage/set_random_seed.md
common_usage/module_combination.md
common_usage/mim_usage.md
common_usage/multi_necks.md
common_usage/specify_device.md
common_usage/single_multi_channel_applications.md
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 2
:caption: Useful Tools
useful_tools/browse_coco_json.md
useful_tools/browse_dataset.md
useful_tools/print_config.md
useful_tools/dataset_analysis.md
useful_tools/optimize_anchors.md
useful_tools/extract_subcoco.md
useful_tools/vis_scheduler.md
useful_tools/dataset_converters.md
useful_tools/download_dataset.md
useful_tools/log_analysis.md
useful_tools/model_converters.md
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 2
:caption: Basic Tutorials
tutorials/config.md
tutorials/data_flow.md
tutorials/custom_installation.md
tutorials/warning_notes.md
tutorials/faq.md
.. toctree::
:maxdepth: 2
:caption: Advanced Tutorials
advanced_guides/cross-library_application.md
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 2
2022-09-18 10:11:55 +08:00
:caption: Model Zoo
model_zoo.md
.. toctree::
:maxdepth: 1
:caption: Notes
notes/changelog.md
notes/compatibility.md
notes/conventions.md
notes/code_style.md
2022-09-18 10:11:55 +08:00
.. toctree::
:maxdepth: 1
:caption: API Reference
api.rst
2022-09-18 10:11:55 +08:00
.. toctree::
:caption: Switch Language
2022-09-18 10:11:55 +08:00
switch_language.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`