codecarbon 3.0.7__tar.gz → 3.0.8__tar.gz

{codecarbon-3.0.7 → codecarbon-3.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codecarbon
-Version: 3.0.7
+Version: 3.0.8
 Author: Mila, DataForGood, BCG GAMMA, Comet.ml, Haverford College
 License-Expression: MIT
 Project-URL: Homepage, https://codecarbon.io/

codecarbon-3.0.8/codecarbon/_version.py

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

{codecarbon-3.0.7 → codecarbon-3.0.8}/codecarbon/core/units.py

@@ -90,7 +90,6 @@ class Energy:
         return Energy(self.kWh + other.kWh)
 
     def __mul__(self, factor: float) -> "Energy":
-        assert isinstance(factor, float)
         assert isinstance(self.kWh, float)
         result = Energy(self.kWh * factor)
         return result
@@ -162,3 +161,19 @@ class Power:
 
     def __floordiv__(self, divisor: float) -> "Power":
         return Power(self.kW // divisor)
+
+
+@dataclass
+class Water:
+    """
+    Measured in litres
+    """
+
+    litres: float
+
+    @classmethod
+    def from_litres(cls, litres: float) -> "Water":
+        return cls(litres=litres)
+
+    def __add__(self, other: "Water") -> "Water":
+        return Water(self.litres + other.litres)

{codecarbon-3.0.7 → codecarbon-3.0.8}/codecarbon/emissions_tracker.py

@@ -17,7 +17,7 @@ from codecarbon._version import __version__
 from codecarbon.core.config import get_hierarchical_config
 from codecarbon.core.emissions import Emissions
 from codecarbon.core.resource_tracker import ResourceTracker
-from codecarbon.core.units import Energy, Power, Time
+from codecarbon.core.units import Energy, Power, Time, Water
 from codecarbon.core.util import count_cpus, count_physical_cpus, suppress
 from codecarbon.external.geography import CloudMetadata, GeoMetadata
 from codecarbon.external.hardware import CPU, GPU, AppleSiliconChip
@@ -179,6 +179,7 @@ class BaseEmissionsTracker(ABC):
         force_cpu_power: Optional[int] = _sentinel,
         force_ram_power: Optional[int] = _sentinel,
         pue: Optional[int] = _sentinel,
+        wue: Optional[bool] = _sentinel,
         force_mode_cpu_load: Optional[bool] = _sentinel,
         allow_multiple_runs: Optional[bool] = _sentinel,
     ):
@@ -238,6 +239,7 @@ class BaseEmissionsTracker(ABC):
         :param pue: PUE (Power Usage Effectiveness) of the datacenter.
         :param force_mode_cpu_load: Force the addition of a CPU in MODE_CPU_LOAD
         :param allow_multiple_runs: Allow multiple instances of codecarbon running in parallel. Defaults to False.
+        :param wue: WUE (Water Usage Effectiveness) of the datacenter, L/kWh.
         """
 
         # logger.info("base tracker init")
@@ -287,6 +289,7 @@ class BaseEmissionsTracker(ABC):
         self._set_from_conf(force_cpu_power, "force_cpu_power", None, float)
         self._set_from_conf(force_ram_power, "force_ram_power", None, float)
         self._set_from_conf(pue, "pue", 1.0, float)
+        self._set_from_conf(wue, "wue", 0, float)
         self._set_from_conf(force_mode_cpu_load, "force_mode_cpu_load", False, bool)
         self._set_from_conf(
             experiment_id, "experiment_id", "5b0fa12a-3dd7-45bb-9766-cc326314d9f1"
@@ -299,6 +302,7 @@ class BaseEmissionsTracker(ABC):
         self._start_time: Optional[float] = None
         self._last_measured_time: float = time.perf_counter()
         self._total_energy: Energy = Energy.from_energy(kWh=0)
+        self._total_water: Water = Water.from_litres(litres=0)
         self._total_cpu_energy: Energy = Energy.from_energy(kWh=0)
         self._total_gpu_energy: Energy = Energy.from_energy(kWh=0)
         self._total_ram_energy: Energy = Energy.from_energy(kWh=0)
@@ -703,6 +707,7 @@ class BaseEmissionsTracker(ABC):
             gpu_energy=self._total_gpu_energy.kWh,
             ram_energy=self._total_ram_energy.kWh,
             energy_consumed=self._total_energy.kWh,
+            water_consumed=self._total_water.litres,
             country_name=country_name,
             country_iso_code=country_iso_code,
             region=region,
@@ -721,6 +726,7 @@ class BaseEmissionsTracker(ABC):
             ram_total_size=self._conf.get("ram_total_size"),
             tracking_mode=self._conf.get("tracking_mode"),
             pue=self._pue,
+            wue=self._wue,
         )
         logger.debug(total_emissions)
         return total_emissions
@@ -778,7 +784,9 @@ class BaseEmissionsTracker(ABC):
             ) = hardware.measure_power_and_energy(last_duration=last_duration)
             # Apply the PUE of the datacenter to the consumed energy
             energy *= self._pue
+            water = Water.from_litres(litres=self._wue * energy.kWh)
             self._total_energy += energy
+            self._total_water += water
             if isinstance(hardware, CPU):
                 self._total_cpu_energy += energy
                 self._cpu_power = power
@@ -825,7 +833,7 @@ class BaseEmissionsTracker(ABC):
                 f"Done measure for {hardware.__class__.__name__} - measurement time: {h_time:,.4f} s - last call {last_duration:,.2f} s"
             )
         logger.info(
-            f"{self._total_energy.kWh:.6f} kWh of electricity used since the beginning."
+            f"{self._total_energy.kWh:.6f} kWh of electricity and {self._total_water.litres:.6f} L of water were used since the beginning."
         )
 
     def _measure_power_and_energy(self) -> None:
@@ -843,7 +851,11 @@ class BaseEmissionsTracker(ABC):
             raise e
 
         warning_duration = self._measure_power_secs * 3
-        if last_duration > warning_duration and not self._scheduler._stopped:
+        if (
+            last_duration > warning_duration
+            and self._scheduler
+            and not self._scheduler._stopped
+        ):
             warn_msg = (
                 "Background scheduler didn't run for a long period"
                 + " (%ds), results might be inaccurate"
@@ -1066,6 +1078,7 @@ def track_emissions(
     force_cpu_power: Optional[int] = _sentinel,
     force_ram_power: Optional[int] = _sentinel,
     pue: Optional[int] = _sentinel,
+    wue: Optional[float] = _sentinel,
     allow_multiple_runs: Optional[bool] = _sentinel,
 ):
     """
@@ -1141,6 +1154,7 @@ def track_emissions(
     :param force_cpu_power: cpu power to be used instead of automatic detection.
     :param force_ram_power: ram power to be used instead of automatic detection.
     :param pue: PUE (Power Usage Effectiveness) of the datacenter.
+    :param wue: WUE (Water Usage Effectiveness) of the datacenter, L/kWh.
     :param allow_multiple_runs: Prevent multiple instances of codecarbon running. Defaults to False.
 
     :return: The decorated function
@@ -1181,6 +1195,7 @@ def track_emissions(
                     force_cpu_power=force_cpu_power,
                     force_ram_power=force_ram_power,
                     pue=pue,
+                    wue=wue,
                     allow_multiple_runs=allow_multiple_runs,
                 )
             else:
@@ -1212,6 +1227,7 @@ def track_emissions(
                     force_cpu_power=force_cpu_power,
                     force_ram_power=force_ram_power,
                     pue=pue,
+                    wue=wue,
                     allow_multiple_runs=allow_multiple_runs,
                 )
             tracker.start()

{codecarbon-3.0.7 → codecarbon-3.0.8}/codecarbon/external/task.py

@@ -34,6 +34,7 @@ class Task:
             gpu_energy=self.emissions_data.gpu_energy,
             ram_energy=self.emissions_data.ram_energy,
             energy_consumed=self.emissions_data.energy_consumed,
+            water_consumed=self.emissions_data.water_consumed,
             country_name=self.emissions_data.country_name,
             country_iso_code=self.emissions_data.country_iso_code,
             region=self.emissions_data.region,

{codecarbon-3.0.7 → codecarbon-3.0.8}/codecarbon/output_methods/emissions_data.py

@@ -23,6 +23,7 @@ class EmissionsData:
     gpu_energy: float
     ram_energy: float
     energy_consumed: float
+    water_consumed: float
     country_name: str
     country_iso_code: str
     region: str
@@ -41,6 +42,7 @@ class EmissionsData:
     tracking_mode: str
     on_cloud: str = "N"
     pue: float = 1
+    wue: float = 0
 
     @property
     def values(self) -> OrderedDict:
@@ -55,6 +57,7 @@ class EmissionsData:
         self.gpu_energy -= previous_emission.gpu_energy
         self.ram_energy -= previous_emission.ram_energy
         self.energy_consumed -= previous_emission.energy_consumed
+        self.water_consumed -= previous_emission.water_consumed
         if delta_duration > 0:
             # emissions_rate in g/s : delta_emissions in kg.CO2 / delta_duration in s
             self.emissions_rate = delta_emissions / delta_duration
@@ -81,6 +84,7 @@ class TaskEmissionsData:
     gpu_energy: float
     ram_energy: float
     energy_consumed: float
+    water_consumed: float
     country_name: str
     country_iso_code: str
     region: str

{codecarbon-3.0.7 → codecarbon-3.0.8}/codecarbon.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codecarbon
-Version: 3.0.7
+Version: 3.0.8
 Author: Mila, DataForGood, BCG GAMMA, Comet.ml, Haverford College
 License-Expression: MIT
 Project-URL: Homepage, https://codecarbon.io/

{codecarbon-3.0.7 → codecarbon-3.0.8}/pyproject.toml

@@ -162,7 +162,7 @@ docs = "cd docs/edit && make docs"
 carbonboard = "python codecarbon/viz/carbonboard.py"
 
 [tool.bumpver]
-current_version = "3.0.7"
+current_version = "3.0.8"
 version_pattern = "MAJOR.MINOR.PATCH[_TAGNUM]"
 
 [tool.bumpver.file_patterns]
@@ -172,3 +172,6 @@ version_pattern = "MAJOR.MINOR.PATCH[_TAGNUM]"
 "docs/edit/conf.py" = [
     '^release = "{version}"$',
 ]
+
+[tool.pytest.ini_options]
+pythonpath = "."

{codecarbon-3.0.7 → codecarbon-3.0.8}/tests/test_api_call.py

@@ -86,6 +86,7 @@ class TestApi(unittest.TestCase):
                 gpu_power=0,
                 ram_power=0.15,
                 energy_consumed=3.0,
+                water_consumed=0.0,
                 country_name="Groland",
                 country_iso_code="GRD",
                 region="EU",

{codecarbon-3.0.7 → codecarbon-3.0.8}/tests/test_emissions_tracker.py

@@ -1,5 +1,6 @@
 import os
 import shutil
+import sys
 import tempfile
 import time
 import unittest
@@ -37,6 +38,16 @@ def heavy_computation(run_time_secs: float = 3):
 empty_conf = "[codecarbon]"
 
 
+if sys.platform == "darwin":
+    mock_platform_cli_setup = mock.patch(
+        "codecarbon.core.powermetrics.ApplePowermetrics._setup_cli"
+    )
+else:
+    mock_platform_cli_setup = mock.patch(
+        "codecarbon.core.cpu.IntelPowerGadget._setup_cli"
+    )
+
+
 @mock.patch("codecarbon.core.gpu.pynvml", fake_pynvml)
 @mock.patch("codecarbon.core.gpu.is_gpu_details_available", return_value=True)
 @mock.patch(
@@ -48,7 +59,7 @@ empty_conf = "[codecarbon]"
     return_value=CloudMetadata(provider=None, region=None),
 )
 @mock.patch("codecarbon.core.cpu.IntelPowerGadget._log_values")
-@mock.patch("codecarbon.core.cpu.IntelPowerGadget._setup_cli")
+@mock_platform_cli_setup
 class TestCarbonTracker(unittest.TestCase):
     def setUp(self) -> None:
         fake_pynvml.DETAILS = TWO_GPU_DETAILS_RESPONSE_HANDLES
@@ -73,7 +84,7 @@ class TestCarbonTracker(unittest.TestCase):
     @responses.activate
     def test_carbon_tracker_TWO_GPU_PRIVATE_INFRA_CANADA(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -89,7 +100,7 @@ class TestCarbonTracker(unittest.TestCase):
         tracker = EmissionsTracker(measure_power_secs=1, save_to_file=False)
         # WHEN
         tracker.start()
-        heavy_computation()
+        heavy_computation(run_time_secs=5)
         emissions = tracker.stop()
 
         # THEN
@@ -108,7 +119,7 @@ class TestCarbonTracker(unittest.TestCase):
     def test_carbon_tracker_timeout(
         self,
         mocked_requests_get,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -135,7 +146,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_graceful_start_failure(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -153,7 +164,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_graceful_stop_failure(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -172,7 +183,7 @@ class TestCarbonTracker(unittest.TestCase):
     @responses.activate
     def test_decorator_ONLINE_NO_ARGS(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -199,7 +210,7 @@ class TestCarbonTracker(unittest.TestCase):
     @responses.activate
     def test_decorator_ONLINE_WITH_ARGS(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -225,7 +236,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_decorator_OFFLINE_NO_COUNTRY(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -241,7 +252,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_decorator_OFFLINE_WITH_LOC_ARGS(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -264,7 +275,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_decorator_OFFLINE_WITH_CLOUD_ARGS(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -287,7 +298,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_offline_tracker_country_name(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -309,7 +320,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_offline_tracker_invalid_headers(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -341,7 +352,7 @@ class TestCarbonTracker(unittest.TestCase):
 
     def test_offline_tracker_valid_headers(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -378,7 +389,7 @@ class TestCarbonTracker(unittest.TestCase):
     @responses.activate
     def test_carbon_tracker_online_context_manager_TWO_GPU_PRIVATE_INFRA_CANADA(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -394,7 +405,7 @@ class TestCarbonTracker(unittest.TestCase):
 
         # WHEN
         with EmissionsTracker(measure_power_secs=1, save_to_file=False) as tracker:
-            heavy_computation()
+            heavy_computation(run_time_secs=5)
 
         # THEN
         self.assertGreaterEqual(
@@ -408,17 +419,18 @@ class TestCarbonTracker(unittest.TestCase):
         self.assertIsInstance(tracker.final_emissions, float)
         self.assertAlmostEqual(tracker.final_emissions, 6.262572537957655e-05, places=2)
 
+    @mock.patch("codecarbon.external.ram.RAM.measure_power_and_energy")
+    @mock.patch("codecarbon.external.hardware.CPU.measure_power_and_energy")
     @mock.patch(
-        "codecarbon.external.ram.RAM.measure_power_and_energy"
-    )  # Corrected path for RAM
-    @mock.patch(
-        "codecarbon.external.hardware.CPU.measure_power_and_energy"
-    )  # Path for CPU is likely correct
+        "codecarbon.external.hardware.AppleSiliconChip.measure_power_and_energy",
+        autospec=True,
+    )
     def test_task_energy_with_live_update_interference(
         self,
+        mock_apple_silicon_measure,
         mock_cpu_measure,  # Method decorator (innermost)
         mock_ram_measure,  # Method decorator (outermost)
-        mock_setup_intel_cli,  # Class decorator (innermost)
+        mock_cli_setup,  # Class decorator (innermost)
         mock_log_values,  # Class decorator
         mocked_env_cloud_details,  # Class decorator
         mocked_get_gpu_details,  # Class decorator
@@ -428,6 +440,19 @@ class TestCarbonTracker(unittest.TestCase):
         # Configure mocks to return specific, non-zero energy values
         cpu_energy_val_task = 0.0001
         ram_energy_val_task = 0.00005
+
+        # On a Mac, AppleSiliconChip.measure_power_and_energy is called for both CPUs and GPU
+        # so we need to check which it is before returning a value.
+        # We chose to return 0 for a GPU to be consistent when testing on Intel.
+        def apple_silicon_side_effect(hardware, *args, **kwargs):
+            if hardware.chip_part == "CPU":
+                return (
+                    Power.from_watts(10),
+                    Energy.from_energy(kWh=cpu_energy_val_task),
+                )
+            return (Power.from_watts(0), Energy.from_energy(kWh=0))
+
+        mock_apple_silicon_measure.side_effect = apple_silicon_side_effect
         mock_cpu_measure.return_value = (
             Power.from_watts(10),
             Energy.from_energy(kWh=cpu_energy_val_task),
@@ -497,14 +522,18 @@ class TestCarbonTracker(unittest.TestCase):
         )
 
         # Verify mocks were called as expected
-        # They are called once in _measure_power_and_energy inside stop_task
-        mock_cpu_measure.assert_called_once()
+        # They are called from within _measure_power_and_energy inside stop_task.
+        # As noted above, mock_apple_silicon_measure is called twice on a Mac, once for CPU and once for GPU.
+        assert (
+            mock_cpu_measure.call_count == 1
+            or mock_apple_silicon_measure.call_count == 2
+        )
         mock_ram_measure.assert_called_once()
 
     @responses.activate
     def test_carbon_tracker_offline_context_manager(
         self,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -525,7 +554,7 @@ class TestCarbonTracker(unittest.TestCase):
     def test_scheduler_warning_suppressed_when_stopped(
         self,
         mock_logger,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,
@@ -567,7 +596,7 @@ class TestCarbonTracker(unittest.TestCase):
     def test_scheduler_warning_shown_when_running(
         self,
         mock_logger,
-        mock_setup_intel_cli,
+        mock_cli_setup,
         mock_log_values,
         mocked_get_gpu_details,
         mocked_env_cloud_details,

codecarbon-3.0.7/codecarbon/_version.py

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