Make codeblocks non-executable
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9.3k
- Forks
- 4.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 4
Description
Certain codeblocks in the Training a Classifier colab should be non-executable; otherwise, users will run and expect output and be confused when they get an error. Specifically the code under the "2. Define a Convolution Neural Network" and the "3. Define a Loss function and optimizer" sections.
They should match the html version: https://pytorch.org/tutorials/beginner/blitz/cifar10_tutorial.html#sphx-glr-beginner-blitz-cifar10-tutorial-py
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Training a Classifier Colab notebook and compare the sections "2. Define a Convolution Neural Network" and "3. Define a Loss function and optimizer" with the linked HTML version. Update the notebook so those codeblocks are non-executable, then verify they no longer invite users to run code that produces the reported error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100