mlcommons / mlcommons/inference
Codebase Refactor: Document submission checker
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.6k
- Forks
- 650
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 6
Description
After the refactor pass, the submission checker needs some light documentation so that every function has docstrings to refer from.
In general, we should aim for docstr-coverage to have 100% docstrings, and try to make sure docstrings are in the Google format so that they can be made into documentation websites easily.
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
Locate the submission checker in the repository and inspect its functions and current docstring coverage. Check how docstr-coverage is run, then document the checker’s functions in Google format until coverage reaches 100% and verify the result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100