Make the descriptions of all models parameters easier to understand (especially for people without in-depth CV context)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 320
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 133
Description
Search before asking
- I have searched the Inference issues and found no similar bug report.
Bug
We shall strive to have all workflows blocks parameters described in such a way that it is easy to understand for
people (even without significant experience in CV). This is not the case now.
Here is PR comment suggesting changes: https://github.com/roboflow/inference/pull/343#discussion_r1585697979
Environment
No response
Minimal Reproducible Example
No response
Additional
No response
Are you willing to submit a PR?
- Yes I'd like to help by submitting a PR!
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 the parameter-description changes and feedback in PR #343, then inventory the workflow-block model parameters that still use unclear wording. Confirm the intended scope with maintainers before editing; done means the affected descriptions are understandable to readers without in-depth computer-vision experience and the documentation checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- computer-vision, python
- Domain
- computer-vision, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100