pytorch
e085c55e - Fix `\\` warnings/errors when building optim documentation (#32911)

Commit
5 years ago
Fix `\\` warnings/errors when building optim documentation (#32911) Summary: This PR fixes the warnings and errors attributed to the use of `\\` outside of a proper environment. While rendered correctly in the documentation, it produces the warning ``` LaTeX-incompatible input and strict mode is set to 'warn': In LaTeX, \\ or \newline does nothing in display mode [newLineInDisplayMode] ``` on the CI tools and errors with ``` ParseError: KaTeX parse error: Expected 'EOF', got '\\' at position (x): ... ``` when not set to warn. This PR also makes minor formatting adjustments. The `CosineAnnealingLR` documentation has been adjusted to remove an unnecessarily large fraction and to improve spacing. The `SGD` documentation has been adjusted so that variables are consistently typeset and so that it follows the convention of punctuating equations. I attached images of the current documentation, the new documentation and a marked version to highlight differences. * SGD: New: ![new_sgd](https://user-images.githubusercontent.com/53704971/73596383-98795500-44d6-11ea-97ce-bac02a0a1638.png) Current: ![current_sgd](https://user-images.githubusercontent.com/53704971/73596384-98795500-44d6-11ea-86d3-b407cebbb513.png) Marked new: ![marked_sgd](https://user-images.githubusercontent.com/53704971/73596385-98795500-44d6-11ea-9e06-9ac5e5e27270.png) * CosineAnnealingLR: New: ![new_calr](https://user-images.githubusercontent.com/53704971/73596382-98795500-44d6-11ea-9c90-02406d297bae.png) Current: ![current_calr](https://user-images.githubusercontent.com/53704971/73596387-9911eb80-44d6-11ea-93fb-ee72d695312a.png) Marked new: ![marked_calr](https://user-images.githubusercontent.com/53704971/73596386-9911eb80-44d6-11ea-91a6-ed7a62b4e255.png) Pull Request resolved: https://github.com/pytorch/pytorch/pull/32911 Differential Revision: D19697114 Pulled By: ezyang fbshipit-source-id: 567304bd4adcfa4086eae497cb818cf74375fe5d
Author
Parents
Loading