Skip to main content

A CodeCarbon wrapper for tracking and reporting energy consumption of ML experiments

Project description

LET - Lamarr Energy Tracker

Lamarr Energy Tracker logo
A simple wrapper around CodeCarbon for tracking and reporting local energy consumption from Python.

Features

  • 🧩 Simple extension to CodeCarbon software
  • 👨‍💻 Three lines of code to report on environmental impacts of your research experiments
  • 💚 Help to make Lamarr Institute more resource-aware

Installation

As a Python library, you can simply install it by running

pip install lamarr-energy-tracker

Usage

LET should be used for custom compute setups (e.g., desktop, workstation, laptop). If you use the Lamarr Cluster, your resource consumption will be automatically tracked (more info soon), so you do not need to use LET. You can include LET in your Python code like this:

from lamarr_energy_tracker import EnergyTracker

# Either use as a context manager
with EnergyTracker(project_name="your_research_project") as tracker:
    # Your resource-heavy code here
    pass

# Or manually
tracker = EnergyTracker(project_name="your_research_project")
tracker.start()
# Your resource-heavy code here
tracker.stop()

Once the tracker is stopped, it will print the energy consumption of your executed experiment as well as a summary statement that you can copy to your paper, describing the environmental impact of all your performed experiments for this project and hardware, for example:

Using CodeCarbon 3.0.8, the energy consumption of running all experiments on an Intel(R) Core(TM) i7-10610U CPU is estimated to 0.135 kWh. This corresponds to estimated carbon emissions of 0.051 kg of CO2-equivalents, assuming a carbon intensity of 380 gCO2/kWh~\cite{lamarr_energy_tracker,codecarbon}. Note that these numbers are underestimations of actual resource consumption and do not account for overhead factors or embodied impacts~\cite{ai_energy_validation}.

Per default, the tracker stores data about tracked resource consumption in a central emissions.csv file, located in ~/.let/. You can also provide a different output_dir or access the tracking results as follows (use arguments to only investigate specific projects):

from lamarr_energy_tracker import load_summary, print_paper_statement, delete_results

# access a pandas dataframe with all tracked resource data
df = load_results()
# print the summary of all tracked resource data
print_paper_statement()
# delete the centrally stored resource data
delete_results()

You can also print the statement directly from the terminal:

python -m lamarr_energy_tracker.print_paper_statement # Default arguments

python -m lamarr_energy_tracker.print_paper_statement --output_dir DIR --project_name NAME --hostname HOST # For additional filtering

Assumptions and Estimation Errors

As mentioned in the impact statement above, the information obtained by CodeCarbon and LET are mere estimates of the ground-truth energy consumption. The tracking works especially well for NVIDIA GPUs (via NVML) and Linux setups, however dynamic CPU profiling with RAPL requires to run all code with sudo. If you want to run code without sudo, you can also run our RAPL access rights script before executing your code.

While the tracker assumes that all code is executed in Germany, you can also provide a different country_iso_code to change the carbon intensity constant, among some other arguments. For more information on the methodology and shortcomings of the tracker, please refer to the CodeCarbon documentation.

If you use some other energy estimation approach, such as the static Machine Learning CO2 Impact Calculator or custom profiling software like jetson-stats (for NVIDIA Jetson [Thor, Orin, Xavier, Nano, TX] series), you can also use LET to print out a custom impact statement, based on the provided methodology, hardware and energy consumption:

# from command-line
python -m lamarr_energy_tracker.print_paper_statement --methodology "the CO2 Impact Calculator" --hardware "NVIDIA GTX 1080 GPU" --consumed_energy 3.2

# from Python
from lamarr_energy_tracker import print_custom_paper_statement
print_custom_paper_statement(methodology="the CO2 Impact Calculator", hardware="NVIDIA GTX 1080 GPU", consumed_energy=3.2):

# outputs:
# Using the CO2 Impact Calculator, the energy consumption of running all experiments on an NVIDIA GTX 1080 GPU is estimated to 3.200 kWh.This corresponds to estimated carbon emissions of 1.216 kgCO2-equivalents, assuming a carbon intensity of 380 gCO2/kWh~\cite{lamarr_energy_tracker,codecarbon}. Note that these numbers are underestimations of actual resource consumption and do not account for overhead factors or embodied impacts~\cite{ai_energy_validation}.

Collaborate

In order to become truly resource-aware, we hope to assemble impact reports about the resource consumption of research projects being conducted at Lamarr Institute. Please send your emissions.csv files to sebastian.buschjaeger@tu-dortmund.de, such that we can include your experiments in our reports. Feel free to add additional information, such as a description of the project and a link to the paper or associated code repository.

Gears icon

Citing

If you use this tool to report your energy consumption, please cite the following literature:

@software{lamarr_energy_tracker,
  author = {Buschjäger, Sebastian and Fischer, Raphael},
  title  = {{Lamarr} {Energy} {Tracker}},
  year   = {2025},
  url    = {https://github.com/lamarr-institute/lamarr-energy-tracker},
}
@software{codecarbon,
  author    = {Courty, Benoît and
               Schmidt, Victor and
               Kamal, Goyal and
               others},
  title     = {mlco2/codecarbon: v3.0.8},
  year      = 2025,
  publisher = {Zenodo},
  version   = {v3.0.8},
  doi       = {10.5281/zenodo.17477894},
  url       = {https://doi.org/10.5281/zenodo.17477894},
}
@misc{ai_energy_validation,
  title  = {Ground-Truthing {AI} Energy Consumption: {Validating} {CodeCarbon} Against External Measurements}, 
  author = {Raphael Fischer},
  year   = {2025},
  doi    = {10.48550/arXiv.2509.22092},
  url    = {https://arxiv.org/abs/2509.22092}, 
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Copyright (c) Resource-Aware ML Research Team @ Lamarr Institute

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lamarr_energy_tracker-0.1.1.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lamarr_energy_tracker-0.1.1-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file lamarr_energy_tracker-0.1.1.tar.gz.

File metadata

  • Download URL: lamarr_energy_tracker-0.1.1.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for lamarr_energy_tracker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7d6a393e5f6a0c443d1ac57489173f74a31de316f979d965874db98d47b5841f
MD5 d4d46516a0dca932c6cfa17d5df089c7
BLAKE2b-256 d3657255fd1b1b9a1a91182fc86b76f5dd036991ced8429e5f3b8d15e8dadc72

See more details on using hashes here.

File details

Details for the file lamarr_energy_tracker-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for lamarr_energy_tracker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd14b5b1819e2c20558ec60c5e154955d6f5a40e6dc609dcf41ec4921887b6d8
MD5 da6c9219a211ca0bbd38a1d428584216
BLAKE2b-256 14924df977eacd8fe48f6bf802a41675eb8577be90cd1f55a1e359d929c37a7c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page