mlpstorage arguments have confusing names that conflict with IEC standards
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 203
- Forks
- 67
- Avg merge
- 20m
- Merged PRs (30d)
- 8
Description
According to the code, CLIENT_HOST_MEMORY_IN_GB is actually in GiB:
https://github.com/search?q=repo%3Amlcommons%2Fstorage%20CLIENT_HOST_MEMORY_IN_GB&type=code
elif args.client_host_memory_in_gb and args.num_client_hosts:
# If host memory per client and num clients is provided, we use these values instead of the calculated memory
per_host_memory_in_bytes = args.client_host_memory_in_gb * 1024 * 1024 * 1024
The command takes --client-host-memory-in-gb as an argument, not --client-host-memory-in-gib. These distinctions are important. The README.md and command help should be updated to make it clear this is in GiB units. Refer to https://physics.nist.gov/cuu/Units/binary.html for more details.
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
Search the Python command argument definition for --client-host-memory-in-gb and inspect README.md for its documentation. Update the command help and README.md so the value is clearly identified as GiB, then verify the displayed argument descriptions are consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100