mlcommons / mlcommons/hpc

[deepcam] Update readme for new LR warmup schedule requirements

Open
#31 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
51
Forks
24
PR merge metrics
No merged PRs in 30d

Description

The deepcam readme still describes the dependency on an external package for the LR warmup scheduler:
https://github.com/mlcommons/hpc/blob/main/deepcam/README.md#before-you-run

My understanding is this is no longer needed because the code was updated to have its own implementation. @azrael417 can you confirm and update the readme?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open deepcam/README.md at the “Before You Run” section linked in the issue and compare its LR warmup scheduler instructions with the current implementation. Confirm whether the external package is still required, then update the README so its dependency guidance matches the implementation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.