2021-10-09 14:10:42 +08:00
|
|
|
Welcome to MMDeploy's documentation!
|
|
|
|
|
====================================
|
|
|
|
|
|
|
|
|
|
You can switch between Chinese and English documents in the lower-left corner of the layout.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
2022-06-07 18:05:51 +08:00
|
|
|
:maxdepth: 2
|
2021-10-09 14:10:42 +08:00
|
|
|
:caption: Get Started
|
|
|
|
|
|
2021-12-24 15:26:50 +08:00
|
|
|
get_started.md
|
2021-10-09 14:10:42 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2022-06-07 18:05:51 +08:00
|
|
|
:caption: Build
|
|
|
|
|
|
|
|
|
|
01-how-to-build/build_from_source.md
|
|
|
|
|
01-how-to-build/build_from_docker.md
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Run & Test
|
|
|
|
|
|
|
|
|
|
02-how-to-run/how_to_convert_model.md
|
|
|
|
|
02-how-to-run/how_to_evaluate_a_model.md
|
|
|
|
|
02-how-to-run/how_to_measure_performance_of_models.md
|
|
|
|
|
02-how-to-run/how_to_write_config.md
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Benchmark
|
|
|
|
|
|
|
|
|
|
03-benchmark/supported_models.md
|
|
|
|
|
03-benchmark/benchmark.md
|
2021-10-09 14:10:42 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2022-06-07 18:05:51 +08:00
|
|
|
:caption: OpenMMLab Codebase Support
|
2021-10-09 14:10:42 +08:00
|
|
|
|
2022-06-07 18:05:51 +08:00
|
|
|
04-supported-codebases/mmcls.md
|
|
|
|
|
04-supported-codebases/mmdet.md
|
|
|
|
|
04-supported-codebases/mmseg.md
|
|
|
|
|
04-supported-codebases/mmedit.md
|
|
|
|
|
04-supported-codebases/mmocr.md
|
|
|
|
|
04-supported-codebases/mmpose.md
|
|
|
|
|
04-supported-codebases/mmdet3d.md
|
|
|
|
|
04-supported-codebases/mmrotate.md
|
2021-10-09 14:10:42 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Backend Support
|
|
|
|
|
|
2022-06-07 18:05:51 +08:00
|
|
|
05-supported-backends/onnxruntime.md
|
|
|
|
|
05-supported-backends/tensorrt.md
|
|
|
|
|
05-supported-backends/openvino.md
|
|
|
|
|
05-supported-backends/ncnn.md
|
|
|
|
|
05-supported-backends/pplnn.md
|
|
|
|
|
05-supported-backends/torchscript.md
|
2021-10-09 14:10:42 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Custom Ops
|
|
|
|
|
|
|
|
|
|
ops/onnxruntime.md
|
|
|
|
|
ops/tensorrt.md
|
|
|
|
|
ops/ncnn.md
|
|
|
|
|
|
2021-12-23 11:25:45 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2022-06-07 18:05:51 +08:00
|
|
|
:caption: Developer Guide
|
|
|
|
|
|
|
|
|
|
06-developer-guide/how_to_support_new_models.md
|
|
|
|
|
06-developer-guide/how_to_support_new_backends.md
|
|
|
|
|
06-developer-guide/how_to_add_test_units_for_backend_ops.md
|
|
|
|
|
06-developer-guide/how_to_test_rewritten_models.md
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Tutorials on Model Deployment
|
2021-12-23 11:25:45 +08:00
|
|
|
|
|
|
|
|
|
2021-10-09 14:10:42 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: FAQ
|
|
|
|
|
|
|
|
|
|
faq.md
|
|
|
|
|
|
2021-12-30 12:36:01 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:caption: Switch Language
|
|
|
|
|
|
|
|
|
|
switch_language.md
|
|
|
|
|
|
2021-10-09 14:10:42 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: API Reference
|
|
|
|
|
|
|
|
|
|
api.rst
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
