mlco2/codecarbon

Too many variables when initializing the EmissionsTracker

Open

#404 opened on May 5, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (306 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (1,885 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

The BaseEmissionsTracker accepts 22 variables when initialized (and growing). This could lead to potential issues. And it is a known code smell.

What I Propose

Refactor the input variables to accept a config dict object as input.

So instead of

EmissionsTracker(project_name: "My project", measure_power_secs=10, output_dir="./temp")

codecarbon could do

config_options = {
    project_name: "My project",
    measure_power_secs=10,
    output_dir="./temp",
}
EmissionsTracker(config_options)

Contributor guide

Research direction
Examine the current BaseEmissionsTracker constructor and identify all parameters. Design a configuration object (e.g., dict or dataclass) that groups these parameters. Implement the refactor to accept the config object while maintaining backward compatibility by optionally allowing the old signature.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70