Skip to content

nesterov parameter of optim.SGD() should be explainid more clearlyΒ #137352

@hyperkai

Description

@hyperkai

πŸ“š The doc issue

The doc of optim.SGD() explains nesterov parameter as shown below but it should be explained more clearly:

nesterov (bool, optional) – enables Nesterov momentum (default: False)

Suggest a potential alternative/fix

So, it should be explained something like as shown below:

nesterov (bool, optional) – If True, Nesterov's Momentum is used while if False, Momentum is used. (default: False)

cc @svekars @brycebortree @sekyondaMeta @vincentqb @jbschlosser @albanD @janeyx99 @crcrpar

Metadata

Metadata

Assignees

No one assigned

    Labels

    module: docsRelated to our documentation, both in docs/ and docblocksmodule: optimizerRelated to torch.optimtriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions