mmengine/docs/en/index.rst
Songyang Zhang aee2f6a688
[Feature] Support model complexity computation (#779)
* [Feature] Add support model complexity computation

* [Fix] fix lint error

* [Feature] update print_helper

* Update docstring

* update api, docs, fix lint

* fix lint

* update doc and add test

* update docstring

* update docstring

* update test

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/print_helper.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update mmengine/analysis/complexity_analysis.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/model_analysis.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/model_analysis.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* update docs

* update docs

* update docs and docstring

* update docs

* update test withj mmlogger

* Update mmengine/analysis/complexity_analysis.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update tests/test_analysis/test_activation_count.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* update test according to review

* Apply suggestions from code review

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* fix lint

* fix test

* Apply suggestions from code review

* fix API document

* Update analysis.rst

* rename variables

* minor refinement

* Apply suggestions from code review

* fix lint

* replace tabulate with existing rich

* Apply suggestions from code review

* indent

* Update mmengine/analysis/complexity_analysis.py

* Update mmengine/analysis/complexity_analysis.py

* Update mmengine/analysis/complexity_analysis.py

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: zhouzaida <zhouzaida@163.com>
2023-02-20 15:00:28 +08:00

121 lines
2.6 KiB
ReStructuredText

Welcome to MMEngine's documentation!
=========================================
You can switch between Chinese and English documents in the lower-left corner of the layout.
.. toctree::
:maxdepth: 1
:caption: Get Started
get_started/introduction.md
get_started/installation.md
get_started/15_minutes.md
.. toctree::
:maxdepth: 1
:caption: Examples
examples/train_a_gan.md
.. toctree::
:maxdepth: 1
:caption: Common Usage
common_usage/resume_training.md
common_usage/speed_up_training.md
common_usage/save_gpu_memory.md
.. toctree::
:maxdepth: 3
:caption: Tutorials
tutorials/runner.md
tutorials/dataset.md
tutorials/model.md
tutorials/evaluation.md
tutorials/optim_wrapper.md
tutorials/param_scheduler.md
tutorials/hook.md
.. toctree::
:maxdepth: 1
:caption: Advanced tutorials
advanced_tutorials/registry.md
advanced_tutorials/config.md
advanced_tutorials/basedataset.md
advanced_tutorials/data_transform.md
advanced_tutorials/initialize.md
advanced_tutorials/visualization.md
advanced_tutorials/data_element.md
advanced_tutorials/distributed.md
advanced_tutorials/logging.md
advanced_tutorials/fileio.md
advanced_tutorials/manager_mixin.md
advanced_tutorials/cross_library.md
advanced_tutorials/test_time_augmentation.md
advanced_tutorials/model_analysis.md
.. toctree::
:maxdepth: 1
:caption: Design
design/hook.md
design/runner.md
design/evaluation.md
design/visualization.md
design/logging.md
design/infer.md
.. toctree::
:maxdepth: 1
:caption: Migration guide
migration/runner.md
migration/hook.md
migration/model.md
migration/param_scheduler.md
migration/transform.md
.. toctree::
:maxdepth: 2
:caption: API Reference
mmengine.analysis <api/analysis>
mmengine.registry <api/registry>
mmengine.config <api/config>
mmengine.runner <api/runner>
mmengine.hooks <api/hooks>
mmengine.model <api/model>
mmengine.optim <api/optim>
mmengine.evaluator <api/evaluator>
mmengine.structures <api/structures>
mmengine.dataset <api/dataset>
mmengine.infer <api/infer>
mmengine.device <api/device>
mmengine.hub <api/hub>
mmengine.logging <api/logging>
mmengine.visualization <api/visualization>
mmengine.fileio <api/fileio>
mmengine.dist <api/dist>
mmengine.utils <api/utils>
mmengine.utils.dl_utils <api/utils.dl_utils>
.. toctree::
:maxdepth: 2
:caption: Notes
notes/changelog.md
notes/contributing.md
.. toctree::
:caption: Switch Language
switch_language.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`