A CodeCarbon wrapper for tracking and reporting energy consumption of ML experiments
Project description
Lamarr Energy Tracker
A simple wrapper around CodeCarbon for tracking and reporting energy consumption from Python.
Features
- 🧩 Simple extension to CodeCarbon
- 👨💻 Only three lines of code to report on environmental impacts of your research
- 💚 Help to make Lamarr Institute more resource-aware
Installation
pip install lamarr-energy-tracker
Usage
from lamarr_energy_tracker import EnergyTracker
# Either use as a context manager
with EnergyTracker(project_name="your_research_project") as tracker:
# Your 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 impact~\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
While the tracker assumes deployment in Germany, you can also provide a different country_iso_code to change the carbon intensity constant.
For more information on the methodology behind the resource tracking, please refer to the CodeCarbon documentation.
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.
Citing
If you use this tool to report your energy consumption, please cite the following literature, for example using the following bibtex entries:
@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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lamarr_energy_tracker-0.1.0.tar.gz.
File metadata
- Download URL: lamarr_energy_tracker-0.1.0.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c8ed1406721e4efeae2467af98502f45cdfbc044deca54bbc2a0b57647d42e6e
|
|
| MD5 |
2df2f0bad7d28454bfccb028a89d6626
|
|
| BLAKE2b-256 |
108da88faef26c5d7fc07f7ee5c2fb44d5e8bdb72a0de3295b8ac34853a875ee
|
File details
Details for the file lamarr_energy_tracker-0.1.0-py3-none-any.whl.
File metadata
- Download URL: lamarr_energy_tracker-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce06c468cc12e52acd1051a5d5d49f85be6f42d8b91a5dac13c67639fab603de
|
|
| MD5 |
1a9d9b6f1a25c3711aed551d1129bbcc
|
|
| BLAKE2b-256 |
7f5e6759583e4fccded1919cba13f98284696d72b98156538372ea6a3a229b6a
|