codecarbon 2.3.0__tar.gz → 2.3.2__tar.gz

{codecarbon-2.3.0 → codecarbon-2.3.2}/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2019 Mila, BCG Gamma, CometML, Haverford College
+Copyright (c) 2023 Code Carbon NGO
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +19,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

{codecarbon-2.3.0/codecarbon.egg-info → codecarbon-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codecarbon
-Version: 2.3.0
+Version: 2.3.2
 Author: Mila, DataForGood, BCG GAMMA, Comet.ml, Haverford College
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3.7
@@ -11,9 +11,24 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arrow
+Requires-Dist: pandas
+Requires-Dist: pynvml
+Requires-Dist: requests
+Requires-Dist: psutil
+Requires-Dist: py-cpuinfo
+Requires-Dist: fuzzywuzzy
+Requires-Dist: click
+Requires-Dist: prometheus_client
 Provides-Extra: viz
+Requires-Dist: dash; extra == "viz"
+Requires-Dist: dash_bootstrap_components<1.0.0; extra == "viz"
+Requires-Dist: fire; extra == "viz"
 Provides-Extra: dashboard
-License-File: LICENSE
+Requires-Dist: dash>=2.2.0; extra == "dashboard"
+Requires-Dist: plotly>=5.6.0; extra == "dashboard"
+Requires-Dist: dash_bootstrap_components; extra == "dashboard"
 
 ![banner](docs/edit/images/banner.png)
 
@@ -26,6 +41,7 @@ Estimate and track carbon emissions from your computer, quantify and analyze the
 [![](https://anaconda.org/conda-forge/codecarbon/badges/version.svg)](https://anaconda.org/conda-forge/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)
+[![Downloads](https://static.pepy.tech/badge/codecarbon/month)](https://pepy.tech/project/codecarbon)
 
 
 - [About CodeCarbon 💡](#about-codecarbon-)
@@ -73,7 +89,7 @@ pip install codecarbon
 ```python
 conda install -c conda-forge codecarbon
 ```
-To see more installation options please refer to the documentation : [**Installation**](https://mlco2.github.io/codecarbon/installation.html#)
+To see more installation options please refer to the documentation: [**Installation**](https://mlco2.github.io/codecarbon/installation.html#)
 
 ## Start to estimate your impact 📏
 

{codecarbon-2.3.0 → codecarbon-2.3.2}/README.md

@@ -9,6 +9,7 @@ Estimate and track carbon emissions from your computer, quantify and analyze the
 [![](https://anaconda.org/conda-forge/codecarbon/badges/version.svg)](https://anaconda.org/conda-forge/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)
+[![Downloads](https://static.pepy.tech/badge/codecarbon/month)](https://pepy.tech/project/codecarbon)
 
 
 - [About CodeCarbon 💡](#about-codecarbon-)
@@ -56,7 +57,7 @@ pip install codecarbon
 ```python
 conda install -c conda-forge codecarbon
 ```
-To see more installation options please refer to the documentation : [**Installation**](https://mlco2.github.io/codecarbon/installation.html#)
+To see more installation options please refer to the documentation: [**Installation**](https://mlco2.github.io/codecarbon/installation.html#)
 
 ## Start to estimate your impact 📏
 

codecarbon-2.3.2/codecarbon/_version.py

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

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/core/cloud.py

@@ -1,24 +1,3 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (C) 2020 [COMET-ML]
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy of this
-# software and associated documentation files (the "Software"), to deal in the Software
-# without restriction, including without limitation the rights to use, copy, modify,
-# merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to the following
-# conditions:
-#
-# The above copyright notice and this permission notice shall be included in all copies
-# or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
-# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
 from typing import Any, Dict, Optional
 
 import requests

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/core/gpu.py

@@ -1,25 +1,3 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (C) 2020 [COMET-ML]
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy of this
-# software and associated documentation files (the "Software"), to deal in the Software
-# without restriction, including without limitation the rights to use, copy, modify,
-# merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to the following
-# conditions:
-#
-# The above copyright notice and this permission notice shall be included in all copies
-# or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
-# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
 from dataclasses import dataclass, field
 
 import pynvml

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/core/util.py

@@ -11,6 +11,11 @@ import psutil
 
 from codecarbon.external.logger import logger
 
+SLURM_JOB_ID = os.environ.get(
+    "SLURM_JOB_ID",  # default
+    os.environ.get("SLURM_JOBID"),  # deprecated but may still be used
+)
+
 
 @contextmanager
 def suppress(*exceptions):
@@ -75,16 +80,20 @@ def detect_cpu_model() -> str:
 
 
 def count_cpus() -> int:
-    if os.environ.get("SLURM_JOB_ID") is None:
+    if SLURM_JOB_ID is None:
         return psutil.cpu_count()
 
     try:
+        logger.debug(
+            "SLURM environment detected for job {SLURM_JOB_ID}, running"
+            + " `scontrol show job $SLURM_JOB_ID` to count SLURM-available cpus."
+        )
         scontrol = subprocess.check_output(
-            ["scontrol show job $SLURM_JOBID"], shell=True
+            [f"scontrol show job {SLURM_JOB_ID}"], shell=True
         ).decode()
     except subprocess.CalledProcessError:
         logger.warning(
-            "Error running `scontrol show job $SLURM_JOBID` "
+            "Error running `scontrol show job $SLURM_JOB_ID` "
             + "to count SLURM-available cpus. Using the machine's cpu count."
         )
         return psutil.cpu_count()
@@ -93,17 +102,18 @@ def count_cpus() -> int:
 
     if len(num_cpus_matches) == 0:
         logger.warning(
-            "Could not find NumCPUs= after running `scontrol show job $SLURM_JOBID` "
+            "Could not find NumCPUs= after running `scontrol show job $SLURM_JOB_ID` "
             + "to count SLURM-available cpus. Using the machine's cpu count."
         )
         return psutil.cpu_count()
 
     if len(num_cpus_matches) > 1:
         logger.warning(
-            "Unexpected output after running `scontrol show job $SLURM_JOBID` "
+            "Unexpected output after running `scontrol show job $SLURM_JOB_ID` "
             + "to count SLURM-available cpus. Using the machine's cpu count."
         )
         return psutil.cpu_count()
 
     num_cpus = num_cpus_matches[0].replace("NumCPUs=", "")
+    logger.debug(f"Detected {num_cpus} cpus available on SLURM.")
     return int(num_cpus)

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/data/hardware/cpu_power.csv

@@ -1991,8 +1991,10 @@ Intel Xeon E3-1285 v4,95
 Intel Xeon E3-1285 v6,79
 Intel Xeon E3-1290,95
 Intel Xeon E3-1290 v2,87
+Intel Xeon E5-1603 v3,140
 Intel Xeon E5-1620 v2,130
 Intel Xeon E5-1650 v2,130
+Intel Xeon E5-1650 v4,140
 Intel Xeon E5-1660 v2,130
 Intel Xeon E5-2403 v2,80
 Intel Xeon E5-2407 v2,80

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/emissions_tracker.py

@@ -433,7 +433,8 @@ class BaseEmissionsTracker(ABC):
         :return: None
         """
         # Stop scheduler as we do not want it to interfere with the task measurement
-        self._scheduler.stop()
+        if self._scheduler:
+            self._scheduler.stop()
 
         if self._active_task:
             logger.info("A task is already under measure")
@@ -457,11 +458,11 @@ class BaseEmissionsTracker(ABC):
         )
         self._active_task = task_name
 
-    def stop_task(self, task_name: str = None) -> float:
+    def stop_task(self, task_name: str = None) -> EmissionsData:
         """
         Stop tracking a dedicated execution task. Delta energy is computed by task, to isolate its contribution to total
         emissions.
-        :return: None
+        :return: EmissionsData
         """
         task_name = task_name if task_name else self._active_task
         self._measure_power_and_energy()

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/external/hardware.py

@@ -1,8 +1,6 @@
 """
 Encapsulates external dependencies to retrieve hardware metadata
 """
-
-import os
 import re
 import subprocess
 from abc import ABC, abstractmethod
@@ -14,7 +12,7 @@ import psutil
 from codecarbon.core.cpu import IntelPowerGadget, IntelRAPL
 from codecarbon.core.gpu import AllGPUDevices
 from codecarbon.core.units import Energy, Power, Time
-from codecarbon.core.util import detect_cpu_model
+from codecarbon.core.util import SLURM_JOB_ID, detect_cpu_model
 from codecarbon.external.logger import logger
 
 # default W value for a CPU if no model is found in the ref csv
@@ -46,7 +44,7 @@ class BaseHardware(ABC):
         )
         return power, energy
 
-    def start(self) -> None:
+    def start(self) -> None:  # noqa B027
         pass
 
 
@@ -168,7 +166,7 @@ class CPU(BaseHardware):
 
         power = 0
         for metric, value in all_cpu_details.items():
-            # "^Processor Power_\d+\(Watt\)$" for Inter Power Gadget
+            # "^Processor Power_\d+\(Watt\)$" for Intel Power Gadget
             if re.match(r"^Processor Power", metric):
                 power += value
                 logger.debug(f"_get_power_from_cpus - MATCH {metric} : {value}")
@@ -238,6 +236,7 @@ class RAM(BaseHardware):
     # 3 watts of power for every 8GB of DDR3 or DDR4 memory
     # https://www.crucial.com/support/articles-faq-memory/how-much-power-does-memory-use
     power_per_GB = 3 / 8  # W/GB
+    memory_size = None
 
     def __init__(
         self,
@@ -273,13 +272,29 @@ class RAM(BaseHardware):
 
     def _read_slurm_scontrol(self):
         try:
-            return subprocess.check_output(
-                ["scontrol show job $SLURM_JOBID"], shell=True
-            ).decode()
+            logger.debug(
+                "SLURM environment detected, running `scontrol show job $SLURM_JOB_ID`..."
+            )
+            return (
+                subprocess.check_output(
+                    [f"scontrol show job {SLURM_JOB_ID}"], shell=True
+                )
+                .decode()
+                .strip()
+            )
         except subprocess.CalledProcessError:
             return
 
     def _parse_scontrol_memory_GB(self, mem):
+        """
+        Parse the memory string (B) returned by scontrol to a float (GB)
+
+        Args:
+            mem (str): Memory string (B) as `[amount][unit]` (e.g. `128G`)
+
+        Returns:
+            float: Memory (GB)
+        """
         nb = int(mem[:-1])
         unit = mem[-1]
         if unit == "T":
@@ -292,16 +307,16 @@ class RAM(BaseHardware):
             return nb / (1000**2)
 
     def _parse_scontrol(self, scontrol_str):
-        mem_matches = re.findall(r"mem=\d+[A-Z]", scontrol_str)
+        mem_matches = re.findall(r"AllocTRES=.*?,mem=(\d+[A-Z])", scontrol_str)
         if len(mem_matches) == 0:
             logger.warning(
-                "Could not find mem= after running `scontrol show job $SLURM_JOBID` "
+                "Could not find mem= after running `scontrol show job $SLURM_JOB_ID` "
                 + "to count SLURM-available RAM. Using the machine's total RAM."
             )
             return psutil.virtual_memory().total / B_TO_GB
         if len(mem_matches) > 1:
             logger.warning(
-                "Unexpected output after running `scontrol show job $SLURM_JOBID` "
+                "Unexpected output after running `scontrol show job $SLURM_JOB_ID` "
                 + "to count SLURM-available RAM. Using the machine's total RAM."
             )
             return psutil.virtual_memory().total / B_TO_GB
@@ -310,17 +325,27 @@ class RAM(BaseHardware):
 
     @property
     def slurm_memory_GB(self):
+        """
+        Property to compute the SLURM-available RAM in GigaBytes.
+
+        Returns:
+            float: Memory allocated to the job (GB)
+        """
+        # Prevent calling scontrol at each mesure
+        if self.memory_size:
+            return self.memory_size
         scontrol_str = self._read_slurm_scontrol()
         if scontrol_str is None:
             logger.warning(
-                "Error running `scontrol show job $SLURM_JOBID` "
+                "Error running `scontrol show job $SLURM_JOB_ID` "
                 + "to retrieve SLURM-available RAM."
                 + "Using the machine's total RAM."
             )
             return psutil.virtual_memory().total / B_TO_GB
         mem = self._parse_scontrol(scontrol_str)
         if isinstance(mem, str):
-            return self._parse_scontrol_memory_GB(mem)
+            mem = self._parse_scontrol_memory_GB(mem)
+        self.memory_size = mem
         return mem
 
     @property
@@ -338,9 +363,15 @@ class RAM(BaseHardware):
 
     @property
     def machine_memory_GB(self):
+        """
+        Property to compute the machine's total memory in bytes.
+
+        Returns:
+            float: Total RAM (GB)
+        """
         return (
             self.slurm_memory_GB
-            if os.environ.get("SLURM_JOB_ID")
+            if SLURM_JOB_ID
             else psutil.virtual_memory().total / B_TO_GB
         )
 

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/external/scheduler.py

@@ -45,7 +45,8 @@ class PeriodicScheduler:
         """
         Stop the scheduler.
         """
-        self._lock.acquire()
-        self._stopped = True
-        self._timer.cancel()
-        self._lock.release()
+        if not self._stopped:
+            self._lock.acquire()
+            self._stopped = True
+            self._timer.cancel()
+            self._lock.release()

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/prometheus/metric_definitions.py

@@ -32,50 +32,60 @@ labelnames = [
 duration_gauge = Gauge(
     "codecarbon_duration",
     "Duration from last measure (s)",
+    ["project_name"],
     registry=registry,
 )
 emissions_gauge = Gauge(
     "codecarbon_emissions",
     "Emissions as CO₂-equivalents [CO₂eq] (kg)",
+    ["project_name"],
     registry=registry,
 )
 emissions_rate_gauge = Gauge(
     "codecarbon_emissions_rate",
     "Emissions divided per duration (Kg/s)",
+    ["project_name"],
     registry=registry,
 )
 cpu_power_gauge = Gauge(
     "codecarbon_cpu_power",
     "CPU power (W)",
+    ["project_name"],
     registry=registry,
 )
 gpu_power_gauge = Gauge(
     "codecarbon_gpu_power",
     "GPU power (W)",
+    ["project_name"],
     registry=registry,
 )
 ram_power_gauge = Gauge(
     "codecarbon_ram_power",
     "RAM power (W)",
+    ["project_name"],
     registry=registry,
 )
 cpu_energy_gauge = Gauge(
     "codecarbon_cpu_energy",
-    "Energy used per CPU (kW)",
+    "Energy used per CPU (kWh)",
+    ["project_name"],
     registry=registry,
 )
 gpu_energy_gauge = Gauge(
     "codecarbon_gpu_energy",
-    "Energy used per GPU (kW)",
+    "Energy used per GPU (kWh)",
+    ["project_name"],
     registry=registry,
 )
 ram_energy_gauge = Gauge(
     "codecarbon_ram_energy",
-    "Energy used per RAM (kW)",
+    "Energy used per RAM (kWh)",
+    ["project_name"],
     registry=registry,
 )
 energy_consumed_gauge = Gauge(
     "codecarbon_energy_consumed",
     "Sum of cpu_energy, gpu_energy and ram_energy (kW)",
+    ["project_name"],
     registry=registry,
 )

codecarbon-2.3.2/codecarbon/prometheus/prometheus.py

@@ -0,0 +1,75 @@
+import os
+
+from prometheus_client import push_to_gateway
+from prometheus_client.exposition import basic_auth_handler
+
+from codecarbon.prometheus.metric_definitions import (
+    cpu_energy_gauge,
+    cpu_power_gauge,
+    duration_gauge,
+    emissions_gauge,
+    emissions_rate_gauge,
+    energy_consumed_gauge,
+    gpu_energy_gauge,
+    gpu_power_gauge,
+    ram_energy_gauge,
+    ram_power_gauge,
+    registry,
+)
+
+
+class Prometheus:
+    def __init__(self, prometheus_url):
+        self.prometheus_url = prometheus_url
+
+    def _auth_handler(self, url, method, timeout, headers, data):
+        username = os.getenv("PROMETHEUS_USERNAME")
+        password = os.getenv("PROMETHEUS_PASSWORD")
+        return basic_auth_handler(
+            url, method, timeout, headers, data, username, password
+        )
+
+    def add_emission(self, carbon_emission: dict):
+        """
+        Send emissions data to push gateway
+        """
+
+        # Save the values of the metrics to the local registry
+        duration_gauge.labels(carbon_emission["project_name"]).set(
+            int(carbon_emission["duration"])
+        )
+        emissions_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["emissions"]
+        )
+        emissions_rate_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["emissions_rate"]
+        )
+        cpu_power_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["cpu_power"]
+        )
+        gpu_power_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["gpu_power"]
+        )
+        ram_power_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["ram_power"]
+        )
+        cpu_energy_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["cpu_energy"]
+        )
+        gpu_energy_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["gpu_energy"]
+        )
+        ram_energy_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["ram_energy"]
+        )
+        energy_consumed_gauge.labels(carbon_emission["project_name"]).set(
+            carbon_emission["energy_consumed"]
+        )
+
+        # Send the new metric values
+        push_to_gateway(
+            self.prometheus_url,
+            job="codecarbon",
+            registry=registry,
+            handler=self._auth_handler,
+        )

{codecarbon-2.3.0 → codecarbon-2.3.2}/codecarbon/viz/components.py

@@ -29,15 +29,20 @@ class Components:
 
     @staticmethod
     def get_header():
-        return dbc.Jumbotron(
-            [
-                html.H1("Carbon Footprint", style={"textAlign": "center"}),
-                html.P(
-                    "Measure Compute Emissions",
-                    style={"textAlign": "center", "paddingLeft": "0.5%"},
-                    className="lead",
-                ),
-            ]
+        return html.Div(
+            dbc.Container(
+                [
+                    html.H1("Carbon Footprint", style={"textAlign": "center"}),
+                    html.P(
+                        "Measure Compute Emissions",
+                        style={"textAlign": "center", "paddingLeft": "0.5%"},
+                        className="lead",
+                    ),
+                ],
+                fluid=True,
+                className="py-3",
+            ),
+            className="p-3 mb-5 bg-light rounded-5",
         )
 
     @staticmethod

{codecarbon-2.3.0 → codecarbon-2.3.2/codecarbon.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codecarbon
-Version: 2.3.0
+Version: 2.3.2
 Author: Mila, DataForGood, BCG GAMMA, Comet.ml, Haverford College
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3.7
@@ -11,9 +11,24 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arrow
+Requires-Dist: pandas
+Requires-Dist: pynvml
+Requires-Dist: requests
+Requires-Dist: psutil
+Requires-Dist: py-cpuinfo
+Requires-Dist: fuzzywuzzy
+Requires-Dist: click
+Requires-Dist: prometheus_client
 Provides-Extra: viz
+Requires-Dist: dash; extra == "viz"
+Requires-Dist: dash_bootstrap_components<1.0.0; extra == "viz"
+Requires-Dist: fire; extra == "viz"
 Provides-Extra: dashboard
-License-File: LICENSE
+Requires-Dist: dash>=2.2.0; extra == "dashboard"
+Requires-Dist: plotly>=5.6.0; extra == "dashboard"
+Requires-Dist: dash_bootstrap_components; extra == "dashboard"
 
 ![banner](docs/edit/images/banner.png)
 
@@ -26,6 +41,7 @@ Estimate and track carbon emissions from your computer, quantify and analyze the
 [![](https://anaconda.org/conda-forge/codecarbon/badges/version.svg)](https://anaconda.org/conda-forge/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)
+[![Downloads](https://static.pepy.tech/badge/codecarbon/month)](https://pepy.tech/project/codecarbon)
 
 
 - [About CodeCarbon 💡](#about-codecarbon-)
@@ -73,7 +89,7 @@ pip install codecarbon
 ```python
 conda install -c conda-forge codecarbon
 ```
-To see more installation options please refer to the documentation : [**Installation**](https://mlco2.github.io/codecarbon/installation.html#)
+To see more installation options please refer to the documentation: [**Installation**](https://mlco2.github.io/codecarbon/installation.html#)
 
 ## Start to estimate your impact 📏
 

{codecarbon-2.3.0 → codecarbon-2.3.2}/setup.py

@@ -20,7 +20,7 @@ TEST_DEPENDENCIES = ["mock", "pytest", "responses", "tox", "numpy", "requests-mo
 
 setuptools.setup(
     name="codecarbon",
-    version="2.3.0",
+    version="2.3.2",
     author="Mila, DataForGood, BCG GAMMA, Comet.ml, Haverford College",
     long_description=long_description,
     long_description_content_type="text/markdown",

codecarbon-2.3.2/tests/test_ram.py

@@ -0,0 +1,84 @@
+import unittest
+from textwrap import dedent
+
+import numpy as np
+
+from codecarbon.external.hardware import RAM
+
+# TODO: need help: test multiprocess case
+
+
+class TestRAM(unittest.TestCase):
+    def test_ram_diff(self):
+        ram = RAM(tracking_mode="process")
+
+        for array_size in [
+            # (10, 10),  # too small to be noticed
+            # (100, 100),  # too small to be noticed
+            (1000, 1000),  # ref for atol
+            (10, 1000, 1000),
+            (20, 1000, 1000),
+            (100, 1000, 1000),
+            (200, 1000, 1000),
+            (1000, 1000, 1000),
+            (2000, 1000, 1000),
+        ]:
+            with self.subTest(array_size=array_size):
+                ref_W = ram.total_power().W
+                array = np.ones(array_size, dtype=np.int8)
+                new_W = ram.total_power().W
+                n_gb = array.nbytes / (1024**3)
+                n_gb_W = (new_W - ref_W) / ram.power_per_GB
+                is_close = np.isclose(n_gb, n_gb_W, atol=1e-3)
+                self.assertTrue(
+                    is_close,
+                    msg=f"{array_size}, {n_gb}, {n_gb_W}, {is_close}",
+                )
+                del array
+
+    def test_ram_slurm(self):
+        scontrol_str = dedent(
+            """\
+            scontrol show job $SLURM_JOB_ID
+            JobId=XXXX JobName=gpu-jupyterhub
+               UserId=XXXX GroupId=XXXX MCS_label=N/A
+               Priority=255342 Nice=0 Account=puk@v100 QOS=qos_gpu-t3
+               JobState=RUNNING Reason=None Dependency=(null)
+               Requeue=1 Restarts=0 BatchFlag=1 Reboot=0 ExitCode=0:0
+               RunTime=00:33:42 TimeLimit=08:00:00 TimeMin=N/A
+               SubmitTime=2023-10-23T10:45:25 EligibleTime=2023-10-23T10:45:25
+               AccrueTime=2023-10-23T10:45:25
+               StartTime=2023-10-23T10:45:35 EndTime=2023-10-23T18:45:35 Deadline=N/A
+               SuspendTime=None SecsPreSuspend=0 LastSchedEval=2023-10-23T10:45:35 Scheduler=Main
+               Partition=gpu_p13 AllocNode:Sid=idrsrv12-ib0:500994
+               ReqNodeList=(null) ExcNodeList=(null)
+               NodeList=r13i5n0
+               BatchHost=r13i5n0
+               NumNodes=1 NumCPUs=64 NumTasks=1 CPUs/Task=32 ReqB:S:C:T=0:0:*:1
+               ReqTRES=cpu=32,mem=128G,node=1,billing=40,gres/gpu=4
+               AllocTRES=cpu=64,mem=128G,node=1,billing=40,gres/gpu=4
+               Socks/Node=* NtasksPerN:B:S:C=0:0:*:* CoreSpec=*
+               MinCPUsNode=32 MinMemoryCPU=4G MinTmpDiskNode=0
+               Features=v100-16g DelayBoot=00:00:00
+               OverSubscribe=OK Contiguous=0 Licenses=(null) Network=(null)
+               Command=(null)
+               WorkDir=/linkhome/rech/gendxh01/uei48xr
+               StdErr=/linkhome/rech/gendxh01/uei48xr/jupyterhub_slurm.err
+               StdIn=/dev/null
+               StdOut=/linkhome/rech/gendxh01/uei48xr/jupyterhub_slurm.out
+               Power=
+               TresPerNode=gres:gpu:4
+            """
+        )
+        ram = RAM(tracking_mode="slurm")
+        ram_size = ram._parse_scontrol(scontrol_str)
+        self.assertEqual(ram_size, "128G")
+        scontrol_str = dedent(
+            """\
+            ReqTRES=cpu=32,mem=134G,node=1,billing=40,gres/gpu=4
+            AllocTRES=cpu=64,mem=42K,node=1,billing=40,gres/gpu=4
+            """
+        )
+        ram = RAM(tracking_mode="slurm")
+        ram_size = ram._parse_scontrol(scontrol_str)
+        self.assertEqual(ram_size, "42K")

codecarbon-2.3.0/codecarbon/_version.py

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

codecarbon-2.3.0/codecarbon/prometheus/prometheus.py

@@ -1,55 +0,0 @@
-import os
-
-from prometheus_client import push_to_gateway
-from prometheus_client.exposition import basic_auth_handler
-
-from codecarbon.prometheus.metric_definitions import (
-    cpu_energy_gauge,
-    cpu_power_gauge,
-    duration_gauge,
-    emissions_gauge,
-    emissions_rate_gauge,
-    energy_consumed_gauge,
-    gpu_energy_gauge,
-    gpu_power_gauge,
-    ram_energy_gauge,
-    ram_power_gauge,
-    registry,
-)
-
-
-class Prometheus:
-    def __init__(self, prometheus_url):
-        self.prometheus_url = prometheus_url
-
-    def _auth_handler(self, url, method, timeout, headers, data):
-        username = os.getenv("PROMETHEUS_USERNAME")
-        password = os.getenv("PROMETHEUS_PASSWORD")
-        return basic_auth_handler(
-            url, method, timeout, headers, data, username, password
-        )
-
-    def add_emission(self, carbon_emission: dict):
-        """
-        Send emissions data to push gateway
-        """
-
-        # Save the values of the metrics to the local registry
-        duration_gauge.set(int(carbon_emission["duration"]))
-        emissions_gauge.set(carbon_emission["emissions"])
-        emissions_rate_gauge.set(carbon_emission["emissions_rate"])
-        cpu_power_gauge.set(carbon_emission["cpu_power"])
-        gpu_power_gauge.set(carbon_emission["gpu_power"])
-        ram_power_gauge.set(carbon_emission["ram_power"])
-        cpu_energy_gauge.set(carbon_emission["cpu_energy"])
-        gpu_energy_gauge.set(carbon_emission["gpu_energy"])
-        ram_energy_gauge.set(carbon_emission["ram_energy"])
-        energy_consumed_gauge.set(carbon_emission["energy_consumed"])
-
-        # Send the new metric values
-        push_to_gateway(
-            self.prometheus_url,
-            job="codecarbon",
-            registry=registry,
-            handler=self._auth_handler,
-        )

codecarbon-2.3.0/tests/test_ram.py

@@ -1,36 +0,0 @@
-import unittest
-
-import numpy as np
-
-from codecarbon.external.hardware import RAM
-
-# TODO: need help: test multiprocess case
-
-
-class TestRAM(unittest.TestCase):
-    def test_ram_diff(self):
-        ram = RAM(tracking_mode="process")
-
-        for array_size in [
-            # (10, 10),  # too small to be noticed
-            # (100, 100),  # too small to be noticed
-            (1000, 1000),  # ref for atol
-            (10, 1000, 1000),
-            (20, 1000, 1000),
-            (100, 1000, 1000),
-            (200, 1000, 1000),
-            (1000, 1000, 1000),
-            (2000, 1000, 1000),
-        ]:
-            with self.subTest(array_size=array_size):
-                ref_W = ram.total_power().W
-                array = np.ones(array_size, dtype=np.int8)
-                new_W = ram.total_power().W
-                n_gb = array.nbytes / (1024**3)
-                n_gb_W = (new_W - ref_W) / ram.power_per_GB
-                is_close = np.isclose(n_gb, n_gb_W, atol=1e-3)
-                self.assertTrue(
-                    is_close,
-                    msg=f"{array_size}, {n_gb}, {n_gb_W}, {is_close}",
-                )
-                del array