codecarbon 3.2.6__tar.gz → 3.2.7__tar.gz

codecarbon-3.2.7/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: codecarbon
+Version: 3.2.7
+Author: Mila, DataForGood, BCG GAMMA, Comet.ml, Haverford College
+License-Expression: MIT
+Project-URL: Homepage, https://codecarbon.io/
+Project-URL: Repository, https://github.com/mlco2/codecarbon
+Project-URL: Dashboard, http://dashboard.codecarbon.io/
+Project-URL: Documentation, https://docs.codecarbon.io/
+Project-URL: Issues, https://github.com/mlco2/codecarbon/issues
+Project-URL: Changelog, https://github.com/mlco2/codecarbon/releases
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arrow
+Requires-Dist: authlib>=1.2.1
+Requires-Dist: click
+Requires-Dist: pandas>=2.3.3; python_version >= "3.14"
+Requires-Dist: pandas; python_version < "3.14"
+Requires-Dist: prometheus_client
+Requires-Dist: psutil>=6.0.0
+Requires-Dist: py-cpuinfo
+Requires-Dist: pydantic
+Requires-Dist: nvidia-ml-py
+Requires-Dist: rapidfuzz
+Requires-Dist: requests
+Requires-Dist: questionary
+Requires-Dist: rich
+Requires-Dist: typer
+Requires-Dist: pycountry
+Provides-Extra: carbonboard
+Requires-Dist: dash; extra == "carbonboard"
+Requires-Dist: dash_bootstrap_components>1.0.0; extra == "carbonboard"
+Requires-Dist: fire; extra == "carbonboard"
+Provides-Extra: viz-legacy
+Requires-Dist: dash; extra == "viz-legacy"
+Requires-Dist: dash_bootstrap_components>1.0.0; extra == "viz-legacy"
+Requires-Dist: fire; extra == "viz-legacy"
+Provides-Extra: amdsmi
+Requires-Dist: amdsmi>=6.0.0; extra == "amdsmi"
+Dynamic: license-file
+
+![banner](docs/images/banner.png)
+
+# Track & reduce CO₂ emissions from your local computing
+
+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) [![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
+pip install codecarbon
+```
+
+If you use Conda:
+
+```bash
+conda activate your_env
+pip install codecarbon
+```
+
+More installation options: [installation docs](https://docs.codecarbon.io/latest/how-to/installation/).
+
+## Quickstart (Python)
+
+```python
+from codecarbon import EmissionsTracker
+
+tracker = EmissionsTracker()
+tracker.start()
+
+# Your code here
+
+emissions = tracker.stop()
+print(f"Emissions: {emissions} kg CO₂")
+```
+
+[**Learn more** →](https://docs.codecarbon.io/latest/tutorials/first-tracking/)
+
+## Quickstart (CLI)
+
+Track a command without changing your code:
+
+```bash
+codecarbon monitor --no-api -- python train.py
+```
+
+Detect your hardware:
+
+```bash
+codecarbon detect
+```
+
+Full CLI guide: [CLI tutorial](https://docs.codecarbon.io/latest/tutorials/cli/).
+
+## Configuration
+
+You can configure CodeCarbon using:
+
+- `~/.codecarbon.config` (global)
+- `./.codecarbon.config` (project-local)
+- `CODECARBON_*` environment variables
+- Python arguments (`EmissionsTracker(...)`)
+
+Configuration precedence and examples: [configuration guide](https://docs.codecarbon.io/latest/how-to/configuration/).
+
+## How it works
+
+We created a Python package that estimates your hardware electricity power consumption (GPU + CPU + RAM) and we apply to it the carbon intensity of the region where the computing is done.
+
+![calculation Summary](docs/images/calculation.png)
+
+We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/latest/explanation/methodology/) section of the documentation.
+
+## Visualize
+
+You can visualize your experiment emissions on the [dashboard](https://dashboard.codecarbon.io/) or locally with [carbonboard](https://docs.codecarbon.io/latest/how-to/visualize/).
+
+![dashboard](docs/images/dashboard.png)
+
+## Quick links
+
+| Section | Description |
+|---------|-------------|
+| [Quickstart](https://docs.codecarbon.io/latest/tutorials/first-tracking/) | Get started in 5 minutes |
+| [Installation](https://docs.codecarbon.io/latest/how-to/installation/) | Install CodeCarbon |
+| [CLI Tutorial](https://docs.codecarbon.io/latest/tutorials/cli/) | Track emissions from the command line |
+| [Python API Tutorial](https://docs.codecarbon.io/latest/tutorials/python-api/) | Track emissions in Python code |
+| [Comparing Model Efficiency](https://docs.codecarbon.io/latest/tutorials/comparing-model-efficiency/) | Measure carbon efficiency across ML models |
+| [API Reference](https://docs.codecarbon.io/latest/reference/api/) | Full parameter documentation |
+| [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
+
+- [Main website](https://codecarbon.io) to learn why we do this.
+- [Dashboard](https://dashboard.codecarbon.io/) to see your emissions.
+- [Documentation](https://docs.codecarbon.io/) to learn how to use the package and our methodology.
+- [EcoLogits](https://ecologits.ai/) to track emissions from GenAI API calls (OpenAI, Anthropic, etc.).
+- [GitHub](https://github.com/mlco2/codecarbon) to look at the source code and contribute.
+- [Discord](https://discord.gg/GS9js2XkJR) to chat with us.
+
+## Contributing
+
+We are hoping that the open-source community will help us edit the code and make it better!
+
+You are welcome to open issues, even suggest solutions and better still contribute the fix/improvement! We can guide you if you're not sure where to start but want to help us out.
+
+Check out our [contribution guidelines](https://github.com/mlco2/codecarbon/blob/master/CONTRIBUTING.md).
+
+Feel free to chat with us on [Discord](https://discord.gg/GS9js2XkJR).
+
+## Citation
+
+If you find CodeCarbon useful for your research, you can find a citation under a variety of formats on [Zenodo](https://zenodo.org/records/11171501).
+
+<details>
+<summary>BibTeX</summary>
+
+```tex
+@software{benoit_courty_2024_11171501,
+  author       = {Benoit Courty and
+                  Victor Schmidt and
+                  Sasha Luccioni and
+                  Goyal-Kamal and
+                  MarionCoutarel and
+                  Boris Feld and
+                  Jérémy Lecourt and
+                  LiamConnell and
+                  Amine Saboni and
+                  Inimaz and
+                  supatomic and
+                  Mathilde Léval and
+                  Luis Blanche and
+                  Alexis Cruveiller and
+                  ouminasara and
+                  Franklin Zhao and
+                  Aditya Joshi and
+                  Alexis Bogroff and
+                  Hugues de Lavoreille and
+                  Niko Laskaris and
+                  Edoardo Abati and
+                  Douglas Blank and
+                  Ziyao Wang and
+                  Armin Catovic and
+                  Marc Alencon and
+                  Michał Stęchły and
+                  Christian Bauer and
+                  Lucas Otávio N. de Araújo and
+                  JPW and
+                  MinervaBooks},
+  title        = {mlco2/codecarbon: v2.4.1},
+  month        = may,
+  year         = 2024,
+  publisher    = {Zenodo},
+  version      = {v2.4.1},
+  doi          = {10.5281/zenodo.11171501},
+  url          = {https://doi.org/10.5281/zenodo.11171501}
+}
+```
+
+</details>
+
+## Contact
+
+Feel free to chat with us on [Discord](https://discord.gg/GS9js2XkJR).
+
+Codecarbon was formerly developed by volunteers from [**Mila**](http://mila.quebec) and the [**DataForGoodFR**](https://twitter.com/dataforgood_fr) community alongside donated professional time of engineers at [**Comet.ml**](https://comet.ml) and [**BCG GAMMA**](https://www.bcg.com/en-nl/beyond-consulting/bcg-gamma/default).
+
+Now CodeCarbon is supported by [**Code Carbon**](https://www.helloasso.com/associations/code-carbon), a French non-profit organization whose mission is to accelerate the development and adoption of CodeCarbon.
+
+### Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=mlco2/codecarbon,lfwa/carbontracker,sb-ai-lab/Eco2AI,fvaleye/tracarbon,Breakend/experiment-impact-tracker&type=Date)](https://star-history.com/#mlco2/codecarbon&lfwa/carbontracker&sb-ai-lab/Eco2AI&fvaleye/tracarbon&Breakend/experiment-impact-tracker&Date)

codecarbon-3.2.7/README.md

@@ -0,0 +1,184 @@
+![banner](docs/images/banner.png)
+
+# Track & reduce CO₂ emissions from your local computing
+
+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) [![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
+pip install codecarbon
+```
+
+If you use Conda:
+
+```bash
+conda activate your_env
+pip install codecarbon
+```
+
+More installation options: [installation docs](https://docs.codecarbon.io/latest/how-to/installation/).
+
+## Quickstart (Python)
+
+```python
+from codecarbon import EmissionsTracker
+
+tracker = EmissionsTracker()
+tracker.start()
+
+# Your code here
+
+emissions = tracker.stop()
+print(f"Emissions: {emissions} kg CO₂")
+```
+
+[**Learn more** →](https://docs.codecarbon.io/latest/tutorials/first-tracking/)
+
+## Quickstart (CLI)
+
+Track a command without changing your code:
+
+```bash
+codecarbon monitor --no-api -- python train.py
+```
+
+Detect your hardware:
+
+```bash
+codecarbon detect
+```
+
+Full CLI guide: [CLI tutorial](https://docs.codecarbon.io/latest/tutorials/cli/).
+
+## Configuration
+
+You can configure CodeCarbon using:
+
+- `~/.codecarbon.config` (global)
+- `./.codecarbon.config` (project-local)
+- `CODECARBON_*` environment variables
+- Python arguments (`EmissionsTracker(...)`)
+
+Configuration precedence and examples: [configuration guide](https://docs.codecarbon.io/latest/how-to/configuration/).
+
+## How it works
+
+We created a Python package that estimates your hardware electricity power consumption (GPU + CPU + RAM) and we apply to it the carbon intensity of the region where the computing is done.
+
+![calculation Summary](docs/images/calculation.png)
+
+We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/latest/explanation/methodology/) section of the documentation.
+
+## Visualize
+
+You can visualize your experiment emissions on the [dashboard](https://dashboard.codecarbon.io/) or locally with [carbonboard](https://docs.codecarbon.io/latest/how-to/visualize/).
+
+![dashboard](docs/images/dashboard.png)
+
+## Quick links
+
+| Section | Description |
+|---------|-------------|
+| [Quickstart](https://docs.codecarbon.io/latest/tutorials/first-tracking/) | Get started in 5 minutes |
+| [Installation](https://docs.codecarbon.io/latest/how-to/installation/) | Install CodeCarbon |
+| [CLI Tutorial](https://docs.codecarbon.io/latest/tutorials/cli/) | Track emissions from the command line |
+| [Python API Tutorial](https://docs.codecarbon.io/latest/tutorials/python-api/) | Track emissions in Python code |
+| [Comparing Model Efficiency](https://docs.codecarbon.io/latest/tutorials/comparing-model-efficiency/) | Measure carbon efficiency across ML models |
+| [API Reference](https://docs.codecarbon.io/latest/reference/api/) | Full parameter documentation |
+| [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
+
+- [Main website](https://codecarbon.io) to learn why we do this.
+- [Dashboard](https://dashboard.codecarbon.io/) to see your emissions.
+- [Documentation](https://docs.codecarbon.io/) to learn how to use the package and our methodology.
+- [EcoLogits](https://ecologits.ai/) to track emissions from GenAI API calls (OpenAI, Anthropic, etc.).
+- [GitHub](https://github.com/mlco2/codecarbon) to look at the source code and contribute.
+- [Discord](https://discord.gg/GS9js2XkJR) to chat with us.
+
+## Contributing
+
+We are hoping that the open-source community will help us edit the code and make it better!
+
+You are welcome to open issues, even suggest solutions and better still contribute the fix/improvement! We can guide you if you're not sure where to start but want to help us out.
+
+Check out our [contribution guidelines](https://github.com/mlco2/codecarbon/blob/master/CONTRIBUTING.md).
+
+Feel free to chat with us on [Discord](https://discord.gg/GS9js2XkJR).
+
+## Citation
+
+If you find CodeCarbon useful for your research, you can find a citation under a variety of formats on [Zenodo](https://zenodo.org/records/11171501).
+
+<details>
+<summary>BibTeX</summary>
+
+```tex
+@software{benoit_courty_2024_11171501,
+  author       = {Benoit Courty and
+                  Victor Schmidt and
+                  Sasha Luccioni and
+                  Goyal-Kamal and
+                  MarionCoutarel and
+                  Boris Feld and
+                  Jérémy Lecourt and
+                  LiamConnell and
+                  Amine Saboni and
+                  Inimaz and
+                  supatomic and
+                  Mathilde Léval and
+                  Luis Blanche and
+                  Alexis Cruveiller and
+                  ouminasara and
+                  Franklin Zhao and
+                  Aditya Joshi and
+                  Alexis Bogroff and
+                  Hugues de Lavoreille and
+                  Niko Laskaris and
+                  Edoardo Abati and
+                  Douglas Blank and
+                  Ziyao Wang and
+                  Armin Catovic and
+                  Marc Alencon and
+                  Michał Stęchły and
+                  Christian Bauer and
+                  Lucas Otávio N. de Araújo and
+                  JPW and
+                  MinervaBooks},
+  title        = {mlco2/codecarbon: v2.4.1},
+  month        = may,
+  year         = 2024,
+  publisher    = {Zenodo},
+  version      = {v2.4.1},
+  doi          = {10.5281/zenodo.11171501},
+  url          = {https://doi.org/10.5281/zenodo.11171501}
+}
+```
+
+</details>
+
+## Contact
+
+Feel free to chat with us on [Discord](https://discord.gg/GS9js2XkJR).
+
+Codecarbon was formerly developed by volunteers from [**Mila**](http://mila.quebec) and the [**DataForGoodFR**](https://twitter.com/dataforgood_fr) community alongside donated professional time of engineers at [**Comet.ml**](https://comet.ml) and [**BCG GAMMA**](https://www.bcg.com/en-nl/beyond-consulting/bcg-gamma/default).
+
+Now CodeCarbon is supported by [**Code Carbon**](https://www.helloasso.com/associations/code-carbon), a French non-profit organization whose mission is to accelerate the development and adoption of CodeCarbon.
+
+### Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=mlco2/codecarbon,lfwa/carbontracker,sb-ai-lab/Eco2AI,fvaleye/tracarbon,Breakend/experiment-impact-tracker&type=Date)](https://star-history.com/#mlco2/codecarbon&lfwa/carbontracker&sb-ai-lab/Eco2AI&fvaleye/tracarbon&Breakend/experiment-impact-tracker&Date)

codecarbon-3.2.7/codecarbon/_version.py

@@ -0,0 +1 @@
+__version__ = "3.2.7"

{codecarbon-3.2.6 → codecarbon-3.2.7}/codecarbon/cli/main.py

@@ -310,7 +310,7 @@ def config():
     overwrite_local_config("api_key", api_key, path=file_path)
     show_config(file_path)
     print(
-        "Consult [link=https://docs.codecarbon.io/latest/getting-started/usage/#configuration]configuration documentation[/link] for more configuration options"
+        "Consult [link=https://docs.codecarbon.io/latest/how-to/configuration/]configuration documentation[/link] for more configuration options"
     )
 
 

{codecarbon-3.2.6 → codecarbon-3.2.7}/codecarbon/core/emissions.py

@@ -25,6 +25,7 @@ class Emissions:
         co2_signal_api_token: Optional[
             str
         ] = None,  # Deprecated, for backward compatibility
+        force_carbon_intensity_g_co2e_kwh: Optional[float] = None,
     ):
         self._data_source = data_source
 
@@ -38,6 +39,7 @@ class Emissions:
                 electricitymaps_api_token = co2_signal_api_token
 
         self._electricitymaps_api_token = electricitymaps_api_token
+        self._force_carbon_intensity_g_co2e_kwh = force_carbon_intensity_g_co2e_kwh
 
     def get_cloud_emissions(
         self, energy: Energy, cloud: CloudMetadata, geo: GeoMetadata = None
@@ -50,6 +52,12 @@ class Emissions:
         :return: CO2 emissions in kg
         """
 
+        if self._force_carbon_intensity_g_co2e_kwh is not None:
+            logger.info(
+                f"Using forced carbon intensity for cloud emissions: {self._force_carbon_intensity_g_co2e_kwh} gCO2e/kWh"
+            )
+            return energy.kWh * (self._force_carbon_intensity_g_co2e_kwh / 1000.0)
+
         df: pd.DataFrame = self._data_source.get_cloud_emissions_data()
         try:
             emissions_per_kWh: EmissionsPerKWh = EmissionsPerKWh.from_g_per_kWh(
@@ -138,6 +146,12 @@ class Emissions:
         :param geo: Country and region metadata
         :return: CO2 emissions in kg
         """
+        if self._force_carbon_intensity_g_co2e_kwh is not None:
+            logger.debug(
+                f"Using forced carbon intensity for private infrastructure emissions: {self._force_carbon_intensity_g_co2e_kwh} gCO2e/kWh"
+            )
+            return energy.kWh * (self._force_carbon_intensity_g_co2e_kwh / 1000.0)
+
         if self._electricitymaps_api_token:
             try:
                 emissions = electricitymaps_api.get_emissions(

{codecarbon-3.2.6 → codecarbon-3.2.7}/codecarbon/core/powermetrics.py

@@ -58,7 +58,7 @@ def _has_powermetrics_sudo() -> bool:
                 """Not using PowerMetrics, sudo password prompt detected.
                     If you want to enable Powermetrics please modify your sudoers file
                     as described in :
-                    https://docs.codecarbon.io/latest/introduction/methodology/#power-usage
+                    https://docs.codecarbon.io/latest/explanation/methodology/#power-usage
                 """
             )
             return False

{codecarbon-3.2.6 → codecarbon-3.2.7}/codecarbon/data/hardware/cpu_power.csv

@@ -2256,6 +2256,7 @@ Intel Core Solo T1400,27
 Intel Core Solo ULV U1300,5
 Intel Core Solo ULV U1400,5
 Intel Core Solo ULV U1500,5
+Intel Core Ultra 7 155H,28
 Intel Core Ultra 7 165H,28
 Intel Core Ultra 7 265H,28
 Intel Core i3-1000G1,12

{codecarbon-3.2.6 → codecarbon-3.2.7}/codecarbon/emissions_tracker.py

@@ -195,6 +195,7 @@ class BaseEmissionsTracker(ABC):
         force_ram_power: Optional[int] = _sentinel,
         pue: Optional[float] = _sentinel,
         wue: Optional[float] = _sentinel,
+        force_carbon_intensity_g_co2e_kwh: Optional[float] = _sentinel,
         force_mode_cpu_load: Optional[bool] = _sentinel,
         allow_multiple_runs: Optional[bool] = _sentinel,
         rapl_include_dram: Optional[bool] = _sentinel,
@@ -259,11 +260,13 @@ class BaseEmissionsTracker(ABC):
                                 then RAM power (W) = Number of RAM Slots × 5 Watts.
         :param pue: PUE (Power Usage Effectiveness) of the data center where the
                     experiment is being run.
+        :param wue: WUE (Water Usage Effectiveness) of the data center. Units of L/kWh:
+                    litres of water consumed per kilowatt-hour of electricity consumed.
+        :param force_carbon_intensity_g_co2e_kwh: Override grid carbon intensity
+                                                  in gCO2e/kWh for emissions calculations.
         :param force_mode_cpu_load: Force the addition of a CPU in MODE_CPU_LOAD
         :param allow_multiple_runs: Allow multiple CodeCarbon instances on the same machine.
                                     Defaults to True since v3 (was False in v2).
-        :param wue: WUE (Water Usage Effectiveness) of the data center. Units of L/kWh:
-                    litres of water consumed per kilowatt-hour of electricity consumed.
         :param rapl_include_dram: Include DRAM (memory) power in RAPL measurements on Linux,
                                   defaults to False. When True, measures CPU package + DRAM.
                                   Only affects systems where RAPL exposes separate DRAM domains.
@@ -276,6 +279,31 @@ class BaseEmissionsTracker(ABC):
 
         # logger.info("base tracker init")
         self._external_conf = get_hierarchical_config()
+        self._set_from_conf(
+            force_carbon_intensity_g_co2e_kwh,
+            "force_carbon_intensity_g_co2e_kwh",
+            None,
+            float,
+        )
+        parsed_intensity = None
+        if self._force_carbon_intensity_g_co2e_kwh is not None:
+            try:
+                value = float(self._force_carbon_intensity_g_co2e_kwh)
+                if value >= 0:
+                    parsed_intensity = value
+                else:
+                    logger.warning(
+                        f"Invalid value for force_carbon_intensity_g_co2e_kwh: '{self._force_carbon_intensity_g_co2e_kwh}'. "
+                        "It must be a non-negative number. Using default calculation methods."
+                    )
+            except (ValueError, TypeError):
+                logger.warning(
+                    f"Invalid value for force_carbon_intensity_g_co2e_kwh: '{self._force_carbon_intensity_g_co2e_kwh}'. "
+                    "It must be a numeric value. Using default calculation methods."
+                )
+        self._force_carbon_intensity_g_co2e_kwh = parsed_intensity
+        self._conf["force_carbon_intensity_g_co2e_kwh"] = parsed_intensity
+        self.force_carbon_intensity_g_co2e_kwh = parsed_intensity
         self._set_from_conf(allow_multiple_runs, "allow_multiple_runs", True, bool)
         if self._allow_multiple_runs:
             logger.warning(
@@ -353,6 +381,11 @@ class BaseEmissionsTracker(ABC):
             experiment_id, "experiment_id", "5b0fa12a-3dd7-45bb-9766-cc326314d9f1"
         )
 
+        if self.force_carbon_intensity_g_co2e_kwh is not None:
+            logger.info(
+                f"Using forced carbon intensity: {self.force_carbon_intensity_g_co2e_kwh} gCO2e/kWh."
+            )
+
         assert self._tracking_mode in ["machine", "process"]
         set_logger_level(self._log_level)
         set_logger_format(self._logger_preamble)
@@ -446,7 +479,9 @@ class BaseEmissionsTracker(ABC):
             self._conf["provider"] = cloud.provider
 
         self._emissions: Emissions = Emissions(
-            self._data_source, self._electricitymaps_api_token
+            self._data_source,
+            self._electricitymaps_api_token,
+            force_carbon_intensity_g_co2e_kwh=self.force_carbon_intensity_g_co2e_kwh,
         )
         self._init_output_methods(api_key=self._api_key)
 
@@ -1310,6 +1345,7 @@ def track_emissions(
     force_ram_power: Optional[int] = _sentinel,
     pue: Optional[float] = _sentinel,
     wue: Optional[float] = _sentinel,
+    force_carbon_intensity_g_co2e_kwh: Optional[float] = _sentinel,
     allow_multiple_runs: Optional[bool] = _sentinel,
     rapl_include_dram: Optional[bool] = _sentinel,
     rapl_prefer_psys: Optional[bool] = _sentinel,
@@ -1392,6 +1428,8 @@ def track_emissions(
     :param pue: PUE (Power Usage Effectiveness) of the data center.
     :param wue: WUE (Water Usage Effectiveness) of the data center. Units of L/kWh:
                 litres of water consumed per kilowatt-hour of electricity consumed.
+    :param force_carbon_intensity_g_co2e_kwh: Override grid carbon intensity
+                         in gCO2e/kWh for emissions calculations.
     :param rapl_include_dram: Include DRAM in RAPL measurements on Linux (default: False).
                               When True, measures CPU package + DRAM.
     :param rapl_prefer_psys: Prefer psys over package domains for RAPL on Linux
@@ -1447,6 +1485,7 @@ def track_emissions(
                     force_ram_power=force_ram_power,
                     pue=pue,
                     wue=wue,
+                    force_carbon_intensity_g_co2e_kwh=force_carbon_intensity_g_co2e_kwh,
                     allow_multiple_runs=allow_multiple_runs,
                     rapl_include_dram=rapl_include_dram,
                     rapl_prefer_psys=rapl_prefer_psys,
@@ -1481,6 +1520,7 @@ def track_emissions(
                     force_ram_power=force_ram_power,
                     pue=pue,
                     wue=wue,
+                    force_carbon_intensity_g_co2e_kwh=force_carbon_intensity_g_co2e_kwh,
                     allow_multiple_runs=allow_multiple_runs,
                     rapl_include_dram=rapl_include_dram,
                     rapl_prefer_psys=rapl_prefer_psys,

{codecarbon-3.2.6 → codecarbon-3.2.7}/codecarbon/external/ram.py

@@ -24,7 +24,7 @@ class RAM(BaseHardware):
     In V3, we need to improve the accuracy of the RAM power estimation.
     Because the power consumption of RAM is not linear with the amount of memory used,
 
-    See https://docs.codecarbon.io/latest/introduction/methodology/#ram for details on the RAM
+    See https://docs.codecarbon.io/latest/explanation/methodology/#ram for details on the RAM
     power estimation methodology.
 
     """