fix(optimization_tutorial): bullet list indentation in colab#3940
fix(optimization_tutorial): bullet list indentation in colab#3940ribhuji wants to merge 1 commit into
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3940
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
Hi @ribhuji! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
@sekyondaMeta @svekars please do look at this minimal change. Tagging acc to this - https://docs.pytorch.org/docs/main/community/persons_of_interest.html#docs-tutorials |
Fixes #3939
Description
Bullet lists under "Hyperparameters", "Optimization Loop", and "Inside the training loop" sections in
optimization_tutorial.pywere rendering as inline text or blockquotes in the generated Jupyter notebook.Root cause: Two issues in the sphinx-gallery to pypandoc pipeline:
# -(3 spaces after#). After sphinx-gallery strips#, the dash was not at column 0, causing pandoc to treat the list as a block quote.Fix: Changed the indentation to
# -(dash at column 0 after stripping) and added a blank#line before each list — matching the convention used by dozens of other tutorials in this repo.Checklist
Testing
_build/html/_downloads/.../optimization_tutorial.ipynbto Colab.Colab link - https://colab.research.google.com/drive/1pTyCPUD8WJmRs1x54V2GpF4c2ke1DlQf?usp=sharing
SS