mlco2 / mlco2/codecarbon

Allow all options to `codecarbon monitor`

Open
#1,273 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Python
Stars
1.9k
Forks
323
Avg merge
1d 12h
Merged PRs (30d)
12

Description

Is your feature request related to a problem? Please describe.
When I run codecarbon monitor --help I only see:

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --measure-power-secs                    <int>  Interval between two measures. [default: 10]              │
│ --api-call-interval                     <int>  Number of measures between API calls. [default: 30]       │
│ --api                   --no-api               Choose to call Code Carbon API or not [default: api]      │
│ --offline               --no-offline           Run in offline mode [default: no-offline]                 │
│ --country-iso-code                      <str>  3-letter country ISO code for offline mode                │
│ --region                                <str>  Region/province for offline mode                          │
│ --log-level                             <str>  Log level (critical, error, warning, info, debug)         │
│                                                [default: error]                                          │
│ --help                                         Show this message and exit.                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Describe the solution you'd like

I would like to have all the options of the package, like PUE, WUE...

It need to be a dynamic implementation, to always be synchronised with the package.

Describe alternatives you've considered
You can already use the .codecarbon.config to set the option.

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

Start with the codecarbon monitor CLI entry point and compare its --help output with the options available through the package and .codecarbon.config. Trace how monitor options are declared, then make the CLI derive its options dynamically so package changes stay synchronized. Done means options such as PUE and WUE appear in codecarbon monitor --help and can be used by the command.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.