mirror of https://github.com/open-mmlab/mmyolo.git
121 lines
2.8 KiB
ReStructuredText
121 lines
2.8 KiB
ReStructuredText
Welcome to MMYOLO's documentation!
|
|
=======================================
|
|
You can switch between Chinese and English documents in the top-right corner of the layout.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
: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
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Recommended Topics
|
|
|
|
recommended_topics/contributing.md
|
|
recommended_topics/training_testing_tricks.md
|
|
recommended_topics/model_design.md
|
|
recommended_topics/algorithm_descriptions/index.rst
|
|
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
|
|
|
|
.. 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
|
|
|
|
|
|
.. 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
|
|
|
|
.. 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
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Model Zoo
|
|
|
|
model_zoo.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Notes
|
|
|
|
notes/changelog.md
|
|
notes/compatibility.md
|
|
notes/conventions.md
|
|
notes/code_style.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: API Reference
|
|
|
|
api.rst
|
|
|
|
.. toctree::
|
|
:caption: Switch Language
|
|
|
|
switch_language.md
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|