pytorch / pytorch/tutorials

💡 [REQUEST] - Remove unnecessary backticks

Open Beginner friendly
#2,308 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

🚀 Descirbe the improvement or the new tutorial

Hi, @svekars.

I'm translating & maintaining the PyTorch tutorials into Korean and incorporating the changes (as the new version is released).

First of all, I want to thank you for the many backticks(`) and spelling improvements that came with the move to 2.0.
However, some articles seem to have added unnecessary backticks and should probably be removed.

For example, on line 78 of thee advanced_source/numpy_extensions_tutorial.py, the backtick seems unnecessary because wrt is short for with respect to.

I've summarized the four issues I found in the three documents below.

I've also found a few cases where the opposite is true - where a backtick appears to be required but isn't, but I'll raise that as a separate issue.

If you think this is a meaningful change, let me know. I'll create a pull request.

Existing tutorials on this topic
Additional context

No response

cc @svekars @carljparker

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 by inspecting the four linked locations in advanced_source/numpy_extensions_tutorial.py, advanced_source/super_resolution_with_onnxruntime.py, and intermediate_source/model_parallel_tutorial.py. Check the surrounding tutorial text and formatting, then remove only the listed unnecessary backticks; done means all four references are corrected without altering other markup.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.