Skip to content

Markdown parsing error in NovoGrad documentation page #2085

@seungjaeryanlee

Description

@seungjaeryanlee

The documentation page of NovoGrad has a broken Markdown link shown below:

novograd

I suspect this is because only the first line of the docstring is used for the first line of the documentation page. In the docstring (shown below), the link spans multiple lines.

"""The NovoGrad Optimizer was first proposed in [Stochastic Gradient
Methods with Layerwise Adaptvie Moments for training of Deep
Networks](https://arxiv.org/pdf/1905.11286.pdf)

The simplest solution would be to edit the docstring so that there is a one-line summary for the first line with a paper link after the newline. One example would be LAMB's documentation page. I will create a PR with this solution.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions