Document other weight meta-data fields
Open
Nobody has claimed this yet.
module: documentation
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
We currently document the number of parameters in the Weights meta-data and we display these on our summary tables. Other values might be of interest for users:
- FLOPs. @Chillee 's FLOP counter might be useful for this -- done in https://github.com/pytorch/vision/pull/6936 and https://github.com/pytorch/vision/pull/7074
- Model size in MB. This will usually be
~= 4 * num_params, except for quantized models. Either-way, it's worth computing and documenting directly (Note: https://github.com/pytorch/vision/pull/6936 added docs for the file size, which may (or may not?) be different) - Memory requirements for 1 image (forward and backward pass). This can be estimated manually but can quickly become untractable, so it's best to do that automatically with a script. We should be able to use
memory_statsmodule for this (accounting for the caching allocator, etc). I'll need to think about this more to make sure what we report is meaningful.
CC @datumbox
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 tracing the existing Weight metadata and the summary-table generation, then compare the file-size documentation added in pull requests 6936 and 7074. Define how model size should be measured, especially for quantized models, and investigate torch.cuda.memory_stats for forward and backward memory estimates. Done means the selected measurements are computed consistently and documented for users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-vision, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100