Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@

Estimate and track carbon emissions from your computer, quantify and analyze their impact.

[![](https://img.shields.io/pypi/v/codecarbon?color=024758)](https://pypi.org/project/codecarbon/) [![DOI](https://zenodo.org/badge/263364731.svg)](https://zenodo.org/badge/latestdoi/263364731) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/mlco2/codecarbon/badge)](https://scorecard.dev/viewer/?uri=github.com/mlco2/codecarbon) [![codecov](https://codecov.io/gh/mlco2/codecarbon/graph/badge.svg)](https://codecov.io/gh/mlco2/codecarbon)
[![](https://img.shields.io/pypi/v/codecarbon?color=024758)](https://pypi.org/project/codecarbon/) [![DOI](https://zenodo.org/badge/263364731.svg)](https://zenodo.org/badge/latestdoi/263364731) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/mlco2/codecarbon/badge)](https://scorecard.dev/viewer/?uri=github.com/mlco2/codecarbon) [![codecov](https://codecov.io/gh/mlco2/codecarbon/graph/badge.svg)](https://codecov.io/gh/mlco2/codecarbon) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/GS9js2XkJR)

- **A lightweight, easy to use Python library** – Simple API to track emissions
- **Open source, free & community driven** – Built by and for the community
- **Effective visual outputs** – Put emissions in context with real-world equivalents

> **Tracking GenAI API calls?** CodeCarbon measures emissions from **local computing** (your hardware). To track emissions from remote GenAI API calls (OpenAI, Anthropic, Mistral, etc.), use [**EcoLogits**](https://ecologits.ai/). Both tools are complementary.

> **Join the community!** Have questions, want to share your work, or contribute? Join us on [**Discord**](https://discord.gg/GS9js2XkJR) – we're here to help and excited to hear from you!

## Installation

```bash
Expand Down Expand Up @@ -97,6 +99,7 @@ You can visualize your experiment emissions on the [dashboard](https://dashboard
| [Framework examples (scikit-learn)](https://docs.codecarbon.io/latest/how-to/scikit-learn/) | Task-oriented ML framework examples |
| [Methodology](https://docs.codecarbon.io/latest/explanation/methodology/) | How emissions are calculated |
| [EcoLogits](https://ecologits.ai/) | Track emissions from GenAI API calls |
| [Discord Community](https://discord.gg/GS9js2XkJR) | Chat with us and the community |

## Links

Expand Down
4 changes: 3 additions & 1 deletion docs/explanation/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Yes. CodeCarbon can be installed and used in Docker containers just like any oth

## How can I help?

If you find any functionality missing in the CodeCarbon repo, please [open an issue](https://github.com/mlco2/codecarbon/issues) so that you (and others!) can help add it. We did our best to cover all use cases and options, but we count on the open source community to help make the package an even greater success.
If you find any functionality missing in the CodeCarbon repo, please [open an issue](https://github.com/mlco2/codecarbon/issues) so that you (and others!) can help add it. We did our best to cover all use cases and options, but we count on the open source community to help make the package an even greater success. You can also discuss ideas on [Discord](https://discord.gg/GS9js2XkJR) before diving into development.

## Is my data sent anywhere?

Expand All @@ -55,3 +55,5 @@ Please open an issue on [GitHub](https://github.com/mlco2/codecarbon/issues) wit
- Your environment details
- Steps to reproduce
- Expected vs actual behavior

You can also report bugs and ask for help on [Discord](https://discord.gg/GS9js2XkJR) where we can provide quick guidance.
2 changes: 1 addition & 1 deletion docs/how-to/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ We agree to restrict the following behaviors in our community. Instances, threat

Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.

When an incident does occur, it is important to report it promptly. To report a possible violation, **[NOTE: describe your means of reporting here.]**
When an incident does occur, it is important to report it promptly. To report a possible violation, please contact us via [GitHub Issues](https://github.com/mlco2/codecarbon/issues) or [Discord](https://discord.gg/GS9js2XkJR).

Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.

Expand Down
6 changes: 5 additions & 1 deletion docs/how-to/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<!-- TOC --><a name="have-a-question"></a>
## </a> Have a Question?

Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for questions.
Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for questions. You can also ask on our [Discord community](https://discord.gg/GS9js2XkJR) – we're happy to help!


<!-- TOC --><a name="found-a-bug"></a>
Expand Down Expand Up @@ -547,6 +547,10 @@ PORT="8000"
```


## Questions or Need Help?

Got stuck? Have an idea? Want to share your contribution? **[Join us on Discord](https://discord.gg/GS9js2XkJR)** – our community is here to help and support you!

<!-- TOC --><a name="license"></a>
## License

Expand Down
1 change: 1 addition & 0 deletions docs/how-to/visualize.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,4 @@ The app also provides a visualization of regional carbon intensity of electricit
- [Set up the Cloud API](cloud-api.md) to send data to the online dashboard
- [Configure CodeCarbon](configuration.md) for additional tracking options
- [Integrate with experiment tracking tools](comet.md) like Comet for seamless workflow integration
- [Join our Discord](https://discord.gg/GS9js2XkJR) to share your results and discuss emissions tracking with the community
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,12 @@ A single datacenter can consume large amounts of energy to run computing code. A
| [Framework Examples](how-to/scikit-learn.md) | Example usage patterns |
| [Methodology](explanation/methodology.md) | How emissions are calculated |
| [EcoLogits](https://ecologits.ai/latest/?utm_source=codecarbon&utm_medium=docs) | Track emissions from GenAI API calls |
| [Discord Community](https://discord.gg/GS9js2XkJR) | Chat with us and the community |

## Contributors & Acknowledgements

CodeCarbon is built by a community of open-source contributors and supported by organizations committed to sustainable computing.

- **[Contributors](https://github.com/mlco2/codecarbon/graphs/contributors)** - See everyone who has contributed to the project
- **[Citation](https://zenodo.org/records/11171501)** - Cite CodeCarbon in your research
- **[Partners](https://github.com/mlco2/codecarbon#partners)** - The organizations supporting this work
12 changes: 10 additions & 2 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,23 @@
}

[data-md-color-scheme="default"] .md-header .md-search__button,
[data-md-color-scheme="default"] .md-search__button,
[data-md-color-scheme="default"] .md-search__button {
color: #0d1f0d !important;
background-color: rgba(0, 0, 0, 0.08) !important;
}

[data-md-color-scheme="slate"] .md-header .md-search__button,
[data-md-color-scheme="slate"] .md-search__button {
color: #ffffff !important;
background-color: rgba(255, 255, 255, 0.15) !important;
}

[data-md-color-scheme="default"] .md-header .md-search__input,
[data-md-color-scheme="default"] .md-search__input,
[data-md-color-scheme="default"] .md-search__input {
color: #0d1f0d !important;
background-color: rgba(0, 0, 0, 0.08) !important;
}

[data-md-color-scheme="slate"] .md-header .md-search__input,
[data-md-color-scheme="slate"] .md-search__input {
color: #ffffff !important;
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorials/first-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,7 @@ print(f"Energy consumed: {tracker.final_emissions_data.energy_consumed:.6f} kWh"
- Explore all [Python API options](python-api.md) (decorators, explicit objects, offline mode)
- See the full [API Reference](../reference/api.md) for all configuration parameters
- Try the [CodeCarbon Workshop notebook](https://github.com/mlco2/codecarbon/blob/master/examples/notebooks/codecarbon_workshop.ipynb) for a comprehensive hands-on experience

## Need help?

Have questions about tracking, want to share your results, or contribute to CodeCarbon? **[Join our Discord community](https://discord.gg/GS9js2XkJR)** – we're here to help!
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -182,3 +182,4 @@ nav:
- Output Formats: reference/output.md
- CLI Reference: reference/cli.md
- Track GenAI API Calls (EcoLogits) ↗: https://ecologits.ai/latest/?utm_source=codecarbon&utm_medium=docs
- Join Our Discord 💬 ↗: https://discord.gg/GS9js2XkJR
Loading