Input Parameters¶
A set of parameters are supported by API to help users provide additional details per project.
EmissionsTracker¶
The online mode object EmissionsTracker
takes following input parameters:
Parameters |
Description |
---|---|
project_name |
Name of the project, defaults to |
measure_power_secs |
Interval (in seconds) to measure hardware power usage, defaults to |
output_dir |
Directory path to which the experiment details are logged
in a CSV file called
emissions.csv , defaults to current directory |
save_to_file |
Boolean variable indicating if the emission artifacts should be logged
to a CSV file at
output_dir/emissions.csv , defaults to True |
OfflineEmissionsTracker¶
The offline mode object OfflineEmissionsTracker
takes following input parameters.
Parameters |
Description |
---|---|
country_iso_code |
3 letter ISO Code of the country where the experiment is being run.
Available countries are listed in global_energy_mix.json
|
region |
Optional Name of the Province/State/City, where the infrastructure is hosted
Currently, supported only for US States
for example - California or New York, from the list
|
project_name |
Name of the project, defaults to |
measure_power_secs |
Interval (in seconds) to measure hardware power usage, defaults to |
output_dir |
Directory path to which the experiment details are logged
in a CSV file called
emissions.csv , defaults to current directory |
save_to_file |
Boolean variable indicating if the emission artifacts should be logged
to a CSV file at
output_dir/emissions.csv , defaults to True |
@track_emissions¶
Decorator track_emissions
takes following input parameters.
Parameters |
Description |
---|---|
project_name |
Name of the project, defaults to |
measure_power_secs |
Interval (in seconds) to measure hardware power usage, defaults to |
output_dir |
Directory path to which the experiment details are logged
in a CSV file called
emissions.csv , defaults to current directory |
save_to_file |
Boolean variable indicating if the emission artifacts should be logged
to a CSV file at
output_dir/emissions.csv , defaults to True |
offline |
Boolean variable indicating if the tracker should be run in offline mode
defaults to
False |
country_iso_code |
3 letter ISO Code of the country where the experiment is being run.
Available countries are listed in global_energy_mix.json
|
region |
Optional Name of the Province/State/City, where the infrastructure is hosted
Currently, supported only for US States
for example - California or New York, from the list
|