mlco2 / mlco2/codecarbon

how use from CLI to measure energy consumed during run of a given command

Open
#382 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

  • CodeCarbon version: ALL
  • Python version: N/A
  • Operating System: Linux
Description

I wish to use codecarbon to give me the energy consumed by my CPU for running a command eg "a.out", so wanted to do something like

codecarbon ./a.out

and get a figure e.g. of Joules of kWh.

How do I do this? I cannot see it within the documentation

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 by reviewing the CodeCarbon CLI documentation and the entry point that handles command execution. Determine whether running a given command such as "a.out" is supported, and document the confirmed invocation and energy output, or clearly state that the capability is unavailable.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.