The explanation for `all_ops` parameter of `AugMix()` is not clear enough.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
📚 The doc issue
The doc of AugMix() explains all_ops parameter as shown below but it's not clear enough:
Parameters:
...
- all_ops (bool, optional) – Use all operations (including brightness, contrast, color and sharpness). Default is True.
Suggest a potential alternative/fix
So it should be something like below:
Parameters:
...
- all_ops (bool, optional) – If
True, all operations are used while ifFalse, all operations excluding brightness, contrast, color and sharpness are used. Default isTrue.
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 with the linked torchvision.transforms.v2.AugMix documentation and locate the all_ops parameter description. Clarify the distinction between using all operations and excluding brightness, contrast, color, and sharpness; done means the generated documentation clearly explains both cases and the default.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, pytorch
- Domain
- computer-vision, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100