Skip to content

Commit d4a91bd

Browse files
committed
Added documentation for carbon code.
1 parent 34127e5 commit d4a91bd

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

src/bikes/jobs.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class Job(abc.ABC, pdt.BaseModel, strict=True):
2727
2828
Attributes:
2929
logger_service (services.LoggerService): manage the logging system.
30+
carbon_service (services.CarbonService): manage the carbon system.
3031
mlflow_service (services.MLflowService): manage the mlflow system.
3132
"""
3233

src/bikes/services.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,17 @@ def start(self) -> None:
8181

8282

8383
class CarbonService(Service):
84-
"""Service for tracking carbon emissions."""
84+
"""Service for tracking carbon emissions.
85+
86+
Attributes:
87+
log_level (str): Level of logging to output.
88+
project_name (str): Name of the project to track.
89+
measure_power_secs (int): Interval for measuring in secs.
90+
output_dir (str): Directory where the output files are stored.
91+
output_file (str): Name of the output CSV file for emissions data.
92+
on_csv_write (str): Specifies the action on writing to CSV (append or overwrite).
93+
country_iso_code (str): ISO code of the country for tracking carbon emissions offline.
94+
"""
8595

8696
# public
8797
# - inputs

0 commit comments

Comments
 (0)