mmengine/docs/en/api/optim.rst
Hakjin Lee 0857f9fb40
[Feature] Support torch ZeroRedundancyOptimizer (#551)
* [Feature] Support torch ZeRORedundancyOptimizer

Co-authored-by: Junhwa Song <ethan9867@gmail.com>
Signed-off-by: Junhwa Song <ethan9867@gmail.com>
Signed-off-by: Hakjin Lee <nijkah@gmail.com>

* lint

* Fix saving optimizer state_dict

* Fix handling import error

* Add test case

* fix UT

* Revert "fix UT"

This reverts commit dd64538960ff7440c6020f533d43945ffc23f2d2.

* fix handling import in UT

* Fix saving zero checkpoint and delete redundant master_only

* lint

* test unittest

* Fix handling impor error

* Fix UT condition

* Edit docstrings

* Fix typo

* Skip redundant procudure in checkpoint hook

* fix typo again

* Update mmengine/optim/optimizer/zero_optimizer.py

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

* Add api info

* lint

* Fix lint

* Handling AmpOptimWrapper case

* handling overlap_with_ddp

* Fix error

Signed-off-by: Junhwa Song <ethan9867@gmail.com>
Signed-off-by: Hakjin Lee <nijkah@gmail.com>
Co-authored-by: Junhwa Song <ethan9867@gmail.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-10-27 20:31:50 +08:00

66 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
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