Class TaskEmissionsTracker

codecarbon/emissions_tracker.py:1384–1411

Track emissions for a specific task This is the context manager for tracking emissions for a specific task. For example: ```py with TaskEmissionsTracker(task_name="Grid search", tracker=tracker): grid = GridSearchCV(estimator=model, param_grid=param_grid) ```

class TaskEmissionsTracker:
    """
    Track emissions for a specific task
    This is the context manager for tracking emissions for a specific task.
    For example:
    ```py
    with TaskEmissionsTracker(task_name="Grid search", tracker=tracker):
        grid = GridSearchCV(estimator=model, param_grid=param_grid)
    ```
    """

    def __init__(self, task_name, tracker: EmissionsTracker = None):
        self.is_default_tracker = False
        if tracker:
            self.tracker = tracker
        else:
            self.tracker = EmissionsTracker()
            self.is_default_tracker = True
        self.task_name = task_name

    def __enter__(self):
        self.tracker.start_task(self.task_name)
        return self

    def __exit__(self, exc_type, exc_value, tb) -> None:
        self.tracker.stop_task()
        if self.is_default_tracker:
            self.tracker.stop()


def track_emissions(