Transforms v2 documentation not congruent w/ fn parameters (```padding_mode```)
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
In many geometric transformations (e.g.: ElasticTransform, RandomAffine, ...) there's a fill parameter specified, and its description states:
Pixel fill value used when the
padding_modeis constant [...]
Issue is, the padding_mode parameter does not exist in the majority of these transforms' constructors! It's a very minor nitpick, but still 😉
Suggest a potential alternative/fix
The quickest fix is obviously removing the part that says 'when the padding_mode is constant', but it could also be turned into a very fun feature request!
A way to implement this functionality would be to just add a quick computation to find out the image size necessary to cover all the frame, perform the Pad transform, and finally complete the geometric transform. There might be a few edge cases though, so that could possibly require some testing.
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 ElasticTransform and RandomAffine documentation pages, then compare each fill description with the constructor parameters. Decide whether the documentation should remove the padding_mode condition or whether a feature is intended; done means the documented parameters and behavior are consistent. No file or test path is identified in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-vision, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100