CarbonAI
This project aims at creating a python package that allows you to monitor the power consumption of any python function.
Documentation
The complete documentation is available here.
Getting started
Install
First of all you need to install the intel utility allowing you to monitor power consumption (support):
To install this package :
pip install carbonai
Example
There are several ways to use this package depending on how you develop. You just have to import the PowerMeter object, initialize it and call the function you want to monitor. Please insert a description of the running function, the dataset, the model, any info would be useful.
Function decorator
To monitor the power consumption of a function, follow this example:
from carbonai import PowerMeter
power_meter = PowerMeter(project_name="MNIST classifier")
@power_meter.measure_power(
package="sklearn",
algorithm="RandomForestClassifier",
data_type="tabular",
data_shape=<your_data>.shape,
algorithm_params="n_estimators=300, max_depth=15",
comments="Classifier trained on the MNIST dataset, 3rd test"
)
def my_func(arg1, arg2, ...):
# Do something
Using the with statement
To monitor the power consumption of some specific inline code, you can use with statements
from carbonai import PowerMeter
power_meter = PowerMeter(project_name="MNIST classifier")
with power_meter(
package="sklearn",
algorithm="RandomForestClassifier",
data_type="tabular",
data_shape=<your_data>.shape,
algorithm_params="n_estimators=300, max_depth=15",
comments="Classifier trained on the MNIST dataset, 3rd test"
):
# Do something
Contribute
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
You can find details on how to contribute in our guide
6 Nov 22, 2022
19 Oct 11, 2022
21 Dec 12, 2022
2 Oct 31, 2022
19 Dec 15, 2022
20 Jul 6, 2022
7 Dec 2, 2022
20 Dec 19, 2022
3 Jul 15, 2022
1 Oct 31, 2021
1 Nov 12, 2021
1 Nov 16, 2021
3 Feb 25, 2022
1 Jan 6, 2022
2 May 22, 2022
16 Nov 13, 2022
13 Dec 2, 2022
0 Oct 21, 2022