mmengine/docs/zh_cn/api/optim.rst
Zaida Zhou 458f6d684e
[Docs] Refactor docs structure (#494)
* [WIP] Refactor-docs-structure

* [Docs] Check link and fix rst  (#498)

* check link

* fix rst

* Fix conf.py

* Fix lint

* minor refine

* minor refine

* modify zh_readme and index.rst

* add migration exampls get_started design to en

* add tutorials to en

* correct chinese doc link

* Apply suggestions from code review

* Update docs/en/advanced_tutorials/distributed.md

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

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
2022-08-31 21:18:55 +08:00

65 lines
1.1 KiB
ReStructuredText

.. role:: hidden
:class: hidden-section
mmengine.optim
===================================
.. contents:: mmengine.optim
:depth: 2
:local:
:backlinks: top
.. currentmodule:: mmengine.optim
Optimizer
----------------
.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst
AmpOptimWrapper
OptimWrapper
OptimWrapperDict
DefaultOptimWrapperConstructor
.. autosummary::
:toctree: generated
:nosignatures:
build_optim_wrapper
Scheduler
----------------
.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst
_ParamScheduler
ConstantLR
ConstantMomentum
ConstantParamScheduler
CosineAnnealingLR
CosineAnnealingMomentum
CosineAnnealingParamScheduler
ExponentialLR
ExponentialMomentum
ExponentialParamScheduler
LinearLR
LinearMomentum
LinearParamScheduler
MultiStepLR
MultiStepMomentum
MultiStepParamScheduler
OneCycleLR
OneCycleParamScheduler
PolyLR
PolyMomentum
PolyParamScheduler
StepLR
StepMomentum
StepParamScheduler