codecarbon 2.5.0__tar.gz → 2.6.0__tar.gz

{codecarbon-2.5.0 → codecarbon-2.6.0}/.gitignore

@@ -126,3 +126,6 @@ code_carbon.db
 # Local file
 emissions*.csv*
 tests/test_data/rapl/*
+
+#asciinema
+*.cast

{codecarbon-2.5.0 → codecarbon-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codecarbon
-Version: 2.5.0
+Version: 2.6.0
 Project-URL: Homepage, https://codecarbon.io/
 Project-URL: Repository, https://github.com/mlco2/codecarbon
 Project-URL: Dashboard, http://dashboard.codecarbon.io/
@@ -25,8 +25,11 @@ Requires-Dist: prometheus-client
 Requires-Dist: psutil
 Requires-Dist: py-cpuinfo
 Requires-Dist: pynvml
+Requires-Dist: questionary
 Requires-Dist: rapidfuzz
 Requires-Dist: requests
+Requires-Dist: rich
+Requires-Dist: typer
 Provides-Extra: viz
 Requires-Dist: dash; extra == 'viz'
 Requires-Dist: dash-bootstrap-components<1.0.0; extra == 'viz'
@@ -190,7 +193,7 @@ Here is a sample for BibTeX:
                   Marc Alencon and
                   Michał Stęchły and
                   Christian Bauer and
-                  Lucas-Otavio and
+                  Lucas Otávio N. de Araújo and
                   JPW and
                   MinervaBooks},
   title        = {mlco2/codecarbon: v2.4.1},

{codecarbon-2.5.0 → codecarbon-2.6.0}/README.md

@@ -155,7 +155,7 @@ Here is a sample for BibTeX:
                   Marc Alencon and
                   Michał Stęchły and
                   Christian Bauer and
-                  Lucas-Otavio and
+                  Lucas Otávio N. de Araújo and
                   JPW and
                   MinervaBooks},
   title        = {mlco2/codecarbon: v2.4.1},

{codecarbon-2.5.0 → codecarbon-2.6.0}/codecarbon/__init__.py

@@ -10,3 +10,4 @@ from .emissions_tracker import (
 )
 
 __all__ = ["EmissionsTracker", "OfflineEmissionsTracker", "track_emissions"]
+__app_name__ = "codecarbon"

codecarbon-2.6.0/codecarbon/_version.py

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

codecarbon-2.6.0/codecarbon/cli/cli_utils.py

@@ -0,0 +1,103 @@
+import configparser
+from pathlib import Path
+from typing import Optional
+
+import typer
+from rich.prompt import Confirm
+
+
+def get_config(path: Optional[Path] = None):
+    p = path or Path.cwd().resolve() / ".codecarbon.config"
+
+    if p.exists():
+        config = configparser.ConfigParser()
+        config.read(str(p))
+        if "codecarbon" in config.sections():
+            d = dict(config["codecarbon"])
+            return d
+
+    else:
+        raise FileNotFoundError(
+            "No .codecarbon.config file found in the current directory."
+        )
+
+
+def get_api_endpoint(path: Optional[Path] = None):
+    p = path or Path.cwd().resolve() / ".codecarbon.config"
+    if p.exists():
+        config = configparser.ConfigParser()
+        config.read(str(p))
+        if "codecarbon" in config.sections():
+            d = dict(config["codecarbon"])
+            if "api_endpoint" in d:
+                return d["api_endpoint"]
+            else:
+                with p.open("a") as f:
+                    f.write("api_endpoint=https://api.codecarbon.io\n")
+    return "https://api.codecarbon.io"
+
+
+def get_existing_local_exp_id(path: Optional[Path] = None):
+    p = path or Path.cwd().resolve() / ".codecarbon.config"
+    if p.exists():
+        config = configparser.ConfigParser()
+        config.read(str(p))
+        if "codecarbon" in config.sections():
+            d = dict(config["codecarbon"])
+            if "experiment_id" in d:
+                return d["experiment_id"]
+
+
+def write_local_exp_id(exp_id, path: Optional[Path] = None):
+    p = path or Path.cwd().resolve() / ".codecarbon.config"
+
+    config = configparser.ConfigParser()
+    if p.exists():
+        config.read(str(p))
+    if "codecarbon" not in config.sections():
+        config.add_section("codecarbon")
+
+    config["codecarbon"]["experiment_id"] = exp_id
+
+    with p.open("w") as f:
+        config.write(f)
+
+
+def overwrite_local_config(config_name, value, path: Optional[Path] = None):
+    p = path or Path.cwd().resolve() / ".codecarbon.config"
+
+    config = configparser.ConfigParser()
+    if p.exists():
+        config.read(str(p))
+    if "codecarbon" not in config.sections():
+        config.add_section("codecarbon")
+
+    config["codecarbon"][config_name] = value
+    with p.open("w") as f:
+        config.write(f)
+
+
+def create_new_config_file():
+    typer.echo("Creating new config file")
+    file_path = typer.prompt(
+        "Where do you want to put your config file ?",
+        type=str,
+        default="~/.codecarbon.config",
+    )
+    if file_path[0] == "~":
+        file_path = Path.home() / file_path[2:]
+    else:
+        file_path = Path(file_path)
+
+    if not file_path.parent.exists():
+        create = Confirm.ask(
+            "Parent folder does not exist do you want to create it (and parents) ?"
+        )
+        if create:
+            file_path.parent.mkdir(parents=True, exist_ok=True)
+
+    file_path.touch()
+    with open(file_path, "w") as f:
+        f.write("[codecarbon]\n")
+    typer.echo(f"Config file created at {file_path}")
+    return file_path

codecarbon-2.6.0/codecarbon/cli/main.py

@@ -0,0 +1,283 @@
+import time
+from pathlib import Path
+from typing import Optional
+
+import questionary
+import typer
+from rich import print
+from rich.prompt import Confirm
+from typing_extensions import Annotated
+
+from codecarbon import __app_name__, __version__
+from codecarbon.cli.cli_utils import (
+    create_new_config_file,
+    get_api_endpoint,
+    get_config,
+    get_existing_local_exp_id,
+    overwrite_local_config,
+)
+from codecarbon.core.api_client import ApiClient, get_datetime_with_timezone
+from codecarbon.core.schemas import ExperimentCreate, OrganizationCreate, ProjectCreate
+from codecarbon.emissions_tracker import EmissionsTracker
+
+DEFAULT_PROJECT_ID = "e60afa92-17b7-4720-91a0-1ae91e409ba1"
+DEFAULT_ORGANIzATION_ID = "e60afa92-17b7-4720-91a0-1ae91e409ba1"
+
+codecarbon = typer.Typer()
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        print(f"{__app_name__} v{__version__}")
+        raise typer.Exit()
+
+
+@codecarbon.callback()
+def main(
+    version: Optional[bool] = typer.Option(
+        None,
+        "--version",
+        "-v",
+        help="Show the application's version and exit.",
+        callback=_version_callback,
+        is_eager=True,
+    ),
+) -> None:
+    return
+
+
+def show_config(path: Path = Path("./.codecarbon.config")) -> None:
+    d = get_config(path)
+    api_endpoint = get_api_endpoint(path)
+    api = ApiClient(endpoint_url=api_endpoint)
+    print("Current configuration : \n")
+    print("Config file content : ")
+    print(d)
+    try:
+        if "organization_id" not in d:
+            print(
+                "No organization_id in config, follow setup instruction to complete your configuration file!",
+            )
+        else:
+            org = api.get_organization(d["organization_id"])
+
+            if "project_id" not in d:
+                print(
+                    "No project_id in config, follow setup instruction to complete your configuration file!",
+                )
+            else:
+                project = api.get_project(d["project_id"])
+                if "experiment_id" not in d:
+                    print(
+                        "No experiment_id in config, follow setup instruction to complete your configuration file!",
+                    )
+                else:
+                    experiment = api.get_experiment(d["experiment_id"])
+                    print("\nExperiment :")
+                    print(experiment)
+                    print("\nProject :")
+                    print(project)
+                    print("\nOrganization :")
+                    print(org)
+    except Exception as e:
+        raise ValueError(
+            f"Your configuration is invalid, please run `codecarbon config --init` first! (error: {e})"
+        )
+
+
+@codecarbon.command("config", short_help="Generate or show config")
+def config():
+    """
+    Initialize CodeCarbon, this will prompt you for configuration of Organisation/Team/Project/Experiment.
+    """
+
+    print("Welcome to CodeCarbon configuration wizard")
+    home = Path.home()
+    global_path = (home / ".codecarbon.config").expanduser().resolve()
+
+    if global_path.exists():
+        print("Existing global config file found :")
+        show_config(global_path)
+
+        use_config = questionary_prompt(
+            "Use existing global ~/.codecarbon.config to configure or create a new file somewhere else ?",
+            ["~/.codecarbon.config", "Create New Config"],
+            default="~/.codecarbon.config",
+        )
+
+        if use_config == "~/.codecarbon.config":
+            modify = Confirm.ask("Do you want to modify the existing config file ?")
+            if modify:
+                print(f"Modifying existing config file {global_path}:")
+                file_path = global_path
+            else:
+                print(f"Using already existing global config file {global_path}")
+
+                return
+        else:
+            file_path = create_new_config_file()
+    else:
+        file_path = create_new_config_file()
+
+    api_endpoint = get_api_endpoint(file_path)
+    api_endpoint = typer.prompt(
+        f"Current API endpoint is {api_endpoint}. Press enter to continue or input other url",
+        type=str,
+        default=api_endpoint,
+    )
+    overwrite_local_config("api_endpoint", api_endpoint, path=file_path)
+    api = ApiClient(endpoint_url=api_endpoint)
+    organizations = api.get_list_organizations()
+    org = questionary_prompt(
+        "Pick existing organization from list or Create new organization ?",
+        [org["name"] for org in organizations] + ["Create New Organization"],
+        default="Create New Organization",
+    )
+
+    if org == "Create New Organization":
+        org_name = typer.prompt("Organization name", default="Code Carbon user test")
+        org_description = typer.prompt(
+            "Organization description", default="Code Carbon user test"
+        )
+
+        organization_create = OrganizationCreate(
+            name=org_name,
+            description=org_description,
+        )
+        organization = api.create_organization(organization=organization_create)
+        print(f"Created organization : {organization}")
+    else:
+        organization = [orga for orga in organizations if orga["name"] == org][0]
+    org_id = organization["id"]
+    overwrite_local_config("organization_id", org_id, path=file_path)
+
+    projects = api.list_projects_from_organization(org_id)
+    project_names = [project["name"] for project in projects] if projects else []
+    project = questionary_prompt(
+        "Pick existing project from list or Create new project ?",
+        project_names + ["Create New Project"],
+        default="Create New Project",
+    )
+    if project == "Create New Project":
+        project_name = typer.prompt("Project name", default="Code Carbon user test")
+        project_description = typer.prompt(
+            "Project description", default="Code Carbon user test"
+        )
+        project_create = ProjectCreate(
+            name=project_name,
+            description=project_description,
+            organization_id=org_id,
+        )
+        project = api.create_project(project=project_create)
+        print(f"Created project : {project}")
+    else:
+        project = [p for p in projects if p["name"] == project][0]
+    project_id = project["id"]
+    overwrite_local_config("project_id", project_id, path=file_path)
+
+    experiments = api.list_experiments_from_project(project_id)
+    experiments_names = (
+        [experiment["name"] for experiment in experiments] if experiments else []
+    )
+
+    experiment = questionary_prompt(
+        "Pick existing experiment from list or Create new experiment ?",
+        experiments_names + ["Create New Experiment"],
+        default="Create New Experiment",
+    )
+    if experiment == "Create New Experiment":
+        print("Creating new experiment")
+        exp_name = typer.prompt("Experiment name :", default="Code Carbon user test")
+        exp_description = typer.prompt(
+            "Experiment description :",
+            default="Code Carbon user test ",
+        )
+
+        exp_on_cloud = Confirm.ask("Is this experiment running on the cloud ?")
+        if exp_on_cloud is True:
+            cloud_provider = typer.prompt(
+                "Cloud provider (AWS, GCP, Azure, ...)", default="AWS"
+            )
+            cloud_region = typer.prompt(
+                "Cloud region (eu-west-1, us-east-1, ...)", default="eu-west-1"
+            )
+        else:
+            cloud_provider = None
+            cloud_region = None
+        country_name = typer.prompt("Country name :", default="Auto")
+        country_iso_code = typer.prompt("Country ISO code :", default="Auto")
+        region = typer.prompt("Region :", default="Auto")
+        if country_name == "Auto":
+            country_name = None
+        if country_iso_code == "Auto":
+            country_iso_code = None
+        if region == "Auto":
+            region = None
+        experiment_create = ExperimentCreate(
+            timestamp=get_datetime_with_timezone(),
+            name=exp_name,
+            description=exp_description,
+            on_cloud=exp_on_cloud,
+            project_id=project["id"],
+            country_name=country_name,
+            country_iso_code=country_iso_code,
+            region=region,
+            cloud_provider=cloud_provider,
+            cloud_region=cloud_region,
+        )
+        experiment = api.add_experiment(experiment=experiment_create)
+
+    else:
+        experiment = [e for e in experiments if e["name"] == experiment][0]
+
+    overwrite_local_config("experiment_id", experiment["id"], path=file_path)
+    show_config(file_path)
+    print(
+        "Consult [link=https://mlco2.github.io/codecarbon/usage.html#configuration]configuration documentation[/link] for more configuration options"
+    )
+
+
+@codecarbon.command("monitor", short_help="Monitor your machine's carbon emissions.")
+def monitor(
+    measure_power_secs: Annotated[
+        int, typer.Argument(help="Interval between two measures.")
+    ] = 10,
+    api_call_interval: Annotated[
+        int, typer.Argument(help="Number of measures between API calls.")
+    ] = 30,
+    api: Annotated[
+        bool, typer.Option(help="Choose to call Code Carbon API or not")
+    ] = True,
+):
+    """Monitor your machine's carbon emissions.
+
+    Args:
+        measure_power_secs (Annotated[int, typer.Argument, optional): Interval between two measures. Defaults to 10.
+        api_call_interval (Annotated[int, typer.Argument, optional): Number of measures before calling API. Defaults to 30.
+        api (Annotated[bool, typer.Option, optional): Choose to call Code Carbon API or not. Defaults to True.
+    """
+    experiment_id = get_existing_local_exp_id()
+    if api and experiment_id is None:
+        print("ERROR: No experiment id, call 'codecarbon init' first.", err=True)
+    print("CodeCarbon is going in an infinite loop to monitor this machine.")
+    with EmissionsTracker(
+        measure_power_secs=measure_power_secs,
+        api_call_interval=api_call_interval,
+        save_to_api=api,
+    ):
+        # Infinite loop
+        while True:
+            time.sleep(300)
+
+
+def questionary_prompt(prompt, list_options, default):
+    value = questionary.select(
+        prompt,
+        list_options,
+        default,
+    ).ask()
+    return value
+
+
+if __name__ == "__main__":
+    codecarbon()

{codecarbon-2.5.0 → codecarbon-2.6.0}/codecarbon/core/api_client.py

@@ -14,7 +14,13 @@ from datetime import timedelta, tzinfo
 import arrow
 import requests
 
-from codecarbon.core.schemas import EmissionCreate, ExperimentCreate, RunCreate
+from codecarbon.core.schemas import (
+    EmissionCreate,
+    ExperimentCreate,
+    OrganizationCreate,
+    ProjectCreate,
+    RunCreate,
+)
 from codecarbon.external.logger import logger
 
 # from codecarbon.output import EmissionsData
@@ -28,7 +34,6 @@ def get_datetime_with_timezone():
 class ApiClient:  # (AsyncClient)
     """
     This class call the Code Carbon API
-    Note : The project, team and organization must have been created in the interface.
     """
 
     run_id = None
@@ -61,6 +66,105 @@ class ApiClient:  # (AsyncClient)
             stacklevel=2,
         )
 
+    def get_list_organizations(self):
+        """
+        List all organizations
+        """
+        url = self.url + "/organizations"
+        r = requests.get(url=url, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, {}, r)
+            return None
+        return r.json()
+
+    def check_organization_exists(self, organization_name: str):
+        """
+        Check if an organization exists
+        """
+        organizations = self.get_list_organizations()
+        if organizations is None:
+            return False
+        for organization in organizations:
+            if organization["name"] == organization_name:
+                return organization
+        return False
+
+    def create_organization(self, organization: OrganizationCreate):
+        """
+        Create an organization
+        """
+        payload = dataclasses.asdict(organization)
+        url = self.url + "/organizations"
+        if organization := self.check_organization_exists(organization.name):
+            logger.warning(
+                f"Organization {organization['name']} already exists. Skipping creation."
+            )
+            return organization
+        else:
+            r = requests.post(url=url, json=payload, timeout=2)
+            if r.status_code != 201:
+                self._log_error(url, payload, r)
+                return None
+            return r.json()
+
+    def get_organization(self, organization_id):
+        """
+        Get an organization
+        """
+        url = self.url + "/organizations/" + organization_id
+        r = requests.get(url=url, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, {}, r)
+            return None
+        return r.json()
+
+    def update_organization(self, organization: OrganizationCreate):
+        """
+        Update an organization
+        """
+        payload = dataclasses.asdict(organization)
+        url = self.url + "/organizations/" + organization.id
+        r = requests.patch(url=url, json=payload, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, payload, r)
+            return None
+        return r.json()
+
+    def list_projects_from_organization(self, organization_id):
+        """
+        List all projects
+        """
+        url = self.url + "/organizations/" + organization_id + "/projects"
+
+        r = requests.get(url=url, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, {}, r)
+            return None
+        return r.json()
+
+    def create_project(self, project: ProjectCreate):
+        """
+        Create a project
+        """
+        payload = dataclasses.asdict(project)
+        url = self.url + "/projects"
+        r = requests.post(url=url, json=payload, timeout=2)
+        if r.status_code != 201:
+            self._log_error(url, payload, r)
+            return None
+        return r.json()
+
+    def get_project(self, project_id):
+        """
+        Get a project
+        """
+        url = self.url + "/projects/" + project_id
+        r = requests.get(url=url, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, {}, r)
+            return None
+        return r.json()
+
     def add_emission(self, carbon_emission: dict):
         assert self.experiment_id is not None
         self._previous_call = time.time()
@@ -97,7 +201,7 @@ class ApiClient:  # (AsyncClient)
         )
         try:
             payload = dataclasses.asdict(emission)
-            url = self.url + "/emission"
+            url = self.url + "/emissions"
             r = requests.post(url=url, json=payload, timeout=2)
             if r.status_code != 201:
                 self._log_error(url, payload, r)
@@ -137,7 +241,7 @@ class ApiClient:  # (AsyncClient)
                 tracking_mode=self.conf.get("tracking_mode"),
             )
             payload = dataclasses.asdict(run)
-            url = self.url + "/run"
+            url = self.url + "/runs"
             r = requests.post(url=url, json=payload, timeout=2)
             if r.status_code != 201:
                 self._log_error(url, payload, r)
@@ -157,24 +261,54 @@ class ApiClient:  # (AsyncClient)
         except Exception as e:
             logger.error(e, exc_info=True)
 
+    def list_experiments_from_project(self, project_id: str):
+        """
+        List all experiments for a project
+        """
+        url = self.url + "/projects/" + project_id + "/experiments"
+        r = requests.get(url=url, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, {}, r)
+            return []
+        return r.json()
+
+    def set_experiment(self, experiment_id: str):
+        """
+        Set the experiment id
+        """
+        self.experiment_id = experiment_id
+
     def add_experiment(self, experiment: ExperimentCreate):
         """
         Create an experiment, used by the CLI, not the package.
         ::experiment:: The experiment to create.
         """
         payload = dataclasses.asdict(experiment)
-        url = self.url + "/experiment"
+        url = self.url + "/experiments"
         r = requests.post(url=url, json=payload, timeout=2)
         if r.status_code != 201:
             self._log_error(url, payload, r)
             return None
-        self.experiment_id = r.json()["id"]
-        return self.experiment_id
+        return r.json()
+
+    def get_experiment(self, experiment_id):
+        """
+        Get an experiment by id
+        """
+        url = self.url + "/experiments/" + experiment_id
+        r = requests.get(url=url, timeout=2)
+        if r.status_code != 200:
+            self._log_error(url, {}, r)
+            return None
+        return r.json()
 
     def _log_error(self, url, payload, response):
-        logger.error(
-            f"ApiClient Error when calling the API on {url} with : {json.dumps(payload)}"
-        )
+        if len(payload) > 0:
+            logger.error(
+                f"ApiClient Error when calling the API on {url} with : {json.dumps(payload)}"
+            )
+        else:
+            logger.error(f"ApiClient Error when calling the API on {url}")
         logger.error(
             f"ApiClient API return http code {response.status_code} and answer : {response.text}"
         )

{codecarbon-2.5.0 → codecarbon-2.6.0}/codecarbon/core/gpu.py

@@ -25,7 +25,10 @@ class GPUDevice:
         self._init_static_details()
 
     def _get_energy_kwh(self):
-        return Energy.from_millijoules(self._get_total_energy_consumption())
+        total_energy_consumption = self._get_total_energy_consumption()
+        if total_energy_consumption is None:
+            return self.last_energy
+        return Energy.from_millijoules(total_energy_consumption)
 
     def delta(self, duration: Time) -> dict:
         """
@@ -92,7 +95,13 @@ class GPUDevice:
         """Returns total energy consumption for this GPU in millijoules (mJ) since the driver was last reloaded
         https://docs.nvidia.com/deploy/nvml-api/group__nvmlDeviceQueries.html#group__nvmlDeviceQueries_1g732ab899b5bd18ac4bfb93c02de4900a
         """
-        return pynvml.nvmlDeviceGetTotalEnergyConsumption(self.handle)
+        try:
+            return pynvml.nvmlDeviceGetTotalEnergyConsumption(self.handle)
+        except pynvml.NVMLError:
+            logger.warning(
+                "Failed to retrieve gpu total energy consumption", exc_info=True
+            )
+            return None
 
     def _get_gpu_name(self):
         """Returns the name of the GPU device