pytorch / pytorch/pytorch.github.io
`register_hook` documentation needs improvement
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 285
- Forks
- 317
- PR merge metrics
- No merged PRs in 30d
Description
📚 Documentation
The formatting https://pytorch.org/docs/stable/generated/torch.Tensor.register_hook.html of Tensor.register_hook is strange, the link after this is broken, and the code example should specify gradient= to the backward call, as this is an unusual use case IMO
Contributor guide
No contributing guide indexed for this repository
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
Start with the linked Tensor.register_hook documentation page and inspect the source for its formatting, the broken link, and the code example. Confirm the rendered page and example use the requested gradient argument, and verify that the link works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, pytorch
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100