meta-pytorch / meta-pytorch/data
Fix & Implement xdoctest
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.3k
- Forks
- 179
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 2
Description
📚 The doc issue
There is a PR https://github.com/pytorch/pytorch/pull/82797 landed into PyTorch core, which adds the functionality to validate if the example in comment is runnable.
However, in the example of PyTorch Core, we normally refer torchdata in all examples for the sake of unification of importing path rather than directly importing DataPipes from pytorch core. This would cause xdoctest always failing. TBH, I don't know how to solve this problem without changing it back to import torch.data.utils.....
But, for torchdata project, we can do the similar work as a BE project to enable all doc test over the examples to prevent any failing test in our documentation.
Suggest a potential alternative/fix
No response
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
Start by reviewing PyTorch core PR #82797 and the torchdata documentation examples that refer to torchdata rather than importing DataPipes directly from PyTorch core. Determine how xdoctest should be enabled for this project and how those examples should be handled; done means documentation examples are validated without the described import-related failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100