mmengine/docs/en/api/optim.rst
xcnick e35ed5fd2e
[Feature] Add ApexOptimWrapper (#742)
* add ApexOptimWrapper

* typo fix

* add apex amp.initialize in optim_context

* assert apex_amp

* polish code

* add parameters of apex_amp.initialize

* add docs

* polish code

* polish code

* polish code

* fix calling of apex amp load_state_dict

* polish

* add comments

* Update apex_optimizer_wrapper.py

* Update apex_optimizer_wrapper.py

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2023-02-06 15:30:10 +08:00

70 lines
1.2 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
ApexOptimWrapper
OptimWrapper
OptimWrapperDict
DefaultOptimWrapperConstructor
ZeroRedundancyOptimizer
.. 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
ReduceOnPlateauLR
ReduceOnPlateauMomentum
ReduceOnPlateauParamScheduler