frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
pytorch/docs/source/optim.aliases.md
Jane Xu 7cc5d03dfc Document the rest of the specific optimizer module APIs (#158669) 
Pull Request resolved: https://github.com/pytorch/pytorch/pull/158669
Approved by: https://github.com/albanD
ghstack dependencies: #158483
2025-07-19 07:27:15 +00:00

2.5 KiB
Raw Permalink Blame History

Aliases in torch.optim

The following are aliases to their counterparts in torch.optim in the nested namespaces in which they are defined. For any of these APIs, feel free to use the top-level version in torch.optim like torch.optim.Adam or the nested version torch.optim.adam.Adam.

.. automodule:: torch.optim.adadelta
.. currentmodule:: torch.optim.adadelta
.. autosummary::
   :toctree: generated
   :nosignatures:

    Adadelta
    adadelta

.. automodule:: torch.optim.adagrad
.. currentmodule:: torch.optim.adagrad
.. autosummary::
   :toctree: generated
   :nosignatures:

    Adagrad
    adagrad

.. automodule:: torch.optim.adam
.. currentmodule:: torch.optim.adam
.. autosummary::
   :toctree: generated
   :nosignatures:

    Adam
    adam

.. automodule:: torch.optim.adamax
.. currentmodule:: torch.optim.adamax
.. autosummary::
   :toctree: generated
   :nosignatures:

    Adamax
    adamax

.. automodule:: torch.optim.adamw
.. currentmodule:: torch.optim.adamw
.. autosummary::
   :toctree: generated
   :nosignatures:

    AdamW
    adamw

.. automodule:: torch.optim.asgd
.. currentmodule:: torch.optim.asgd
.. autosummary::
   :toctree: generated
   :nosignatures:

    ASGD
    asgd

.. automodule:: torch.optim.lbfgs
.. currentmodule:: torch.optim.lbfgs
.. autosummary::
   :toctree: generated
   :nosignatures:

    LBFGS

.. automodule:: torch.optim.nadam
.. currentmodule:: torch.optim.nadam
.. autosummary::
   :toctree: generated
   :nosignatures:

    NAdam
    nadam

.. automodule:: torch.optim.radam
.. currentmodule:: torch.optim.radam
.. autosummary::
   :toctree: generated
   :nosignatures:

    RAdam
    radam

.. automodule:: torch.optim.rmsprop
.. currentmodule:: torch.optim.rmsprop
.. autosummary::
   :toctree: generated
   :nosignatures:

    RMSprop
    rmsprop

.. automodule:: torch.optim.rprop
.. currentmodule:: torch.optim.rprop
.. autosummary::
   :toctree: generated
   :nosignatures:

    Rprop
    rprop

.. automodule:: torch.optim.sgd
.. currentmodule:: torch.optim.sgd
.. autosummary::
   :toctree: generated
   :nosignatures:

    SGD
    sgd

.. automodule:: torch.optim.sparse_adam
.. currentmodule:: torch.optim.sparse_adam
.. autosummary::
   :toctree: generated
   :nosignatures:

    SparseAdam