Method start_task

codecarbon/emissions_tracker.py:699–760

Start tracking a dedicated execution task. :param task_name: Name of the task to be isolated. :return: None

(self, task_name=None)

        self._scheduler_monitor_power.start()

    def start_task(self, task_name=None) -> None:
        """
        Start tracking a dedicated execution task.
        :param task_name: Name of the task to be isolated.
        :return: None
        """
        # if another instance of codecarbon is already running, stop here
        if (
            hasattr(self, "_another_instance_already_running")
            and self._another_instance_already_running
        ):
            logger.warning(
                "Another instance of codecarbon is already running. Exiting."
            )
            return
        try:
            _ = self._emissions
        except AttributeError:
            logger.error("Tracker not initialized. Please check the logs.")
            return

        # Stop scheduler as we do not want it to interfere with the task measurement
        if self._scheduler:
            self._scheduler.stop()

        # Task background thread for measuring power
        self._scheduler_monitor_power.start()

        if self._active_task:
            logger.warning("A task is already under measure")
            return
        if not task_name:
            task_name = uuid.uuid4().__str__()
        if task_name in self._tasks.keys():
            task_name += "_" + uuid.uuid4().__str__()
        self._last_measured_time = self._start_time = time.perf_counter()

        # Clear utilization history for fresh measurements
        self._cpu_utilization_history.clear()
        self._ram_utilization_history.clear()
        self._ram_used_history.clear()
        self._gpu_utilization_history.clear()

        # Read initial energy for hardware
        for hardware in self._hardware:
            hardware.start()
        prepared_data_for_task_start = self._prepare_emissions_data()
        self._active_task_emissions_at_start = dataclasses.replace(
            prepared_data_for_task_start
        )
        # The existing call to _compute_emissions_delta uses the result of _prepare_emissions_data.
        # Let's make sure it uses the same one we captured.
        self._compute_emissions_delta(prepared_data_for_task_start)

        self._tasks.update(
            {
                task_name: Task(
                    task_name=task_name,