pytorch / pytorch/tutorials

[BUG] - Incorrect list rendering in Google Colab tutorials

Open
#3,946 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
9.3k
Forks
4.4k
Avg merge
1d 21h
Merged PRs (30d)
4

Description

Add Link
  1. https://docs.pytorch.org/tutorials/advanced/usb_semisup_learn.html
  2. https://docs.pytorch.org/tutorials/beginner/basics/autogradqs_tutorial.html
  3. https://docs.pytorch.org/tutorials/beginner/basics/data_tutorial.html
  4. https://docs.pytorch.org/tutorials/beginner/blitz/neural_networks_tutorial.html
  5. https://docs.pytorch.org/tutorials/beginner/nn_tutorial.html
  6. https://docs.pytorch.org/tutorials/intermediate/optimizer_step_in_backward_tutorial.html
  7. https://docs.pytorch.org/tutorials/recipes/recipes/profiler_recipe.html
  8. https://docs.pytorch.org/tutorials/recipes/recipes/timer_quick_start.html
  9. https://docs.pytorch.org/tutorials/recipes/torch_compiler_set_stance_tutorial.html
  10. https://docs.pytorch.org/tutorials/unstable/gpu_direct_storage.html
Describe the bug
Description

The list-rendering problem previously reported in #3939 also occurs in several other tutorials.

On the PyTorch Tutorials HTML pages, the affected lists render correctly. However, after opening the generated notebooks through Run in Google Colab, the same content is not rendered as a proper list.

Steps to reproduce
  1. Open one of the tutorial pages listed below.
  2. Select Run in Google Colab.
  3. Navigate to the affected section.
  4. Compare the list in Google Colab with the corresponding list on the tutorial HTML page.
Affected tutorials
1. USB Semi-Supervised Learning

Tutorial: https://docs.pytorch.org/tutorials/advanced/usb_semisup_learn.html

Affected content: the list of functions imported from semilearn in the Use USB to Train FreeMatch/SoftMatch on CIFAR-10 with only 40 labels section.

Image
2. Automatic Differentiation with torch.autograd

Tutorial: https://docs.pytorch.org/tutorials/beginner/basics/autogradqs_tutorial.html

Affected content:

  • the list in the note explaining gradient availability; and
  • the list of reasons for disabling gradient tracking.
Image
3. Datasets & DataLoaders

Tutorial: https://docs.pytorch.org/tutorials/beginner/basics/data_tutorial.html

Affected content: the FashionMNIST parameter list in the Loading a Dataset section.

Image
4. Neural Networks

Tutorial: https://docs.pytorch.org/tutorials/beginner/blitz/neural_networks_tutorial.html

Affected content: the lists under Recap, At this point, we covered, and Still Left.

Image
5. What is torch.nn really?

Tutorial: https://docs.pytorch.org/tutorials/beginner/nn_tutorial.html

Affected content: the list of assumptions in the Wrapping DataLoader section.

Image
6. Optimizer Step in Backward

Tutorial: https://docs.pytorch.org/tutorials/intermediate/optimizer_step_in_backward_tutorial.html

Affected content: the numbered list following Several major observations.

Image
7. PyTorch Profiler

Tutorial: https://docs.pytorch.org/tutorials/recipes/recipes/profiler_recipe.html

Affected content: the nested activity types under the activities profiler parameter in the Using profiler to analyze execution time section.

Image
8. Timer Quick Start

Tutorial: https://docs.pytorch.org/tutorials/recipes/recipes/timer_quick_start.html

Affected content: the Contents list near the beginning of the tutorial.

Image
9. Changing the Compilation Stance

Tutorial: https://docs.pytorch.org/tutorials/recipes/torch_compiler_set_stance_tutorial.html

Affected content: the list following Other stances include.

Image
10. GPU Direct Storage

Tutorial: https://docs.pytorch.org/tutorials/unstable/gpu_direct_storage.html

Affected content: the list following The steps involved in the process are as follows.

Image
Expected result

Lists in the generated Google Colab notebooks should preserve the same structure as the corresponding lists on the PyTorch Tutorials HTML pages:

  • each item should appear on a separate line;
  • bullet and numbered lists should retain their markers;
  • nested items should retain their hierarchy; and
  • surrounding prose should remain separate from the list.
Describe your environment

Google Colab

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the ten tutorial URLs listed in the issue and compare each affected section in the HTML page with its generated Google Colab notebook, using the related issue #3939 for context. Check the tutorial sources and notebook-generation path to identify the shared list-rendering problem. Done means all listed tutorials preserve separate items, markers, nesting, and surrounding prose in Colab.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.