[Version 3] Add CPU load tracking

[benoit-cty]

When none of RAPL or PowerGadget is available, the mode will use CPU load to estimate the CPU Power.

How to test:

export CODECARBON_LOG_LEVEL=DEBUG

To check if it's working : CPU load 180 W x 90.9% = 163.62 for whole machine.

If you want to monitor only your process:

export CODECARBON_TRACKING_MODE=process

TODO:

• Add test
• Check that it works when in RAPL mode and file is read protected we switch to this mode.
• Fix test error "AttributeError: 'OfflineEmissionsTracker' object has no attribute '_country_name'" in Github Action
• Add support for process mode (See https://stackoverflow.com/questions/41206809/psutil-measuring-the-cpu-usage-of-a-specific-process )
• Tests to do:
  • Test on a VM
  • Test under container LXC
  • Test under Docker
  • Test under Windows
  • Test under Linux with RAPL
  • Test under Linux without RAPL

[benoit-cty]

Will close #333

[benoit-cty]

Here is how to test:

git switch use-cpu-load
codecarbon monitor

If you have RAPL, the log will display a comparison between RAPL and the new estimation based on CPU load:

------------------------
[codecarbon INFO @ 19:09:11] Energy consumed for RAM : 0.000312 kWh. RAM Power : 11.692474365234375 W
[codecarbon DEBUG @ 19:09:11] Done measure for RAM - measurement time: 0.0005 s - last call 6.13 s
[codecarbon INFO @ 19:09:11] Energy consumed for all GPUs : 0.000959 kWh. Total GPU Power : 19.64000343421216 W
[codecarbon DEBUG @ 19:09:11] Done measure for GPU - measurement time: 0.0031 s - last call 6.13 s
[codecarbon DEBUG @ 19:09:11] RAPLFile(name='Processor Energy Delta_0(kWh)', path='/sys/class/powercap/intel-rapl/intel-rapl:1/energy_uj', max_path='/sys/class/powercap/intel-rapl/intel-rapl:1/max_energy_range_uj', energy_delta=Energy(kWh=0.00012791769844518533), power=Power(kW=0.0750830161810631), last_energy=Energy(kWh=0.015906780571247607), max_energy_reading=Energy(kWh=0.018203517614746884))
[codecarbon DEBUG @ 19:09:11] RAPLFile(name='Processor Energy Delta_1(kWh)', path='/sys/class/powercap/intel-rapl/intel-rapl:0/energy_uj', max_path='/sys/class/powercap/intel-rapl/intel-rapl:0/max_energy_range_uj', energy_delta=Energy(kWh=0.00012790536065753963), power=Power(kW=0.07507577435041182), last_energy=Energy(kWh=0.015906798529039753), max_energy_reading=Energy(kWh=0.018203517614746884))
[codecarbon DEBUG @ 19:09:11] get_cpu_details {'Processor Energy Delta_0(kWh)': 0.00012791769844518533, 'Processor Power Delta_0(kWh)': 75.0830161810631, 'Processor Energy Delta_1(kWh)': 0.00012790536065753963, 'Processor Power Delta_1(kWh)': 75.07577435041182}
[codecarbon DEBUG @ 19:09:11] get_static_cpu_details {'Processor Energy Delta_0(kWh)': 0.00012791769844518533, 'Processor Power Delta_0(kWh)': 75.0830161810631, 'Processor Energy Delta_1(kWh)': 0.00012790536065753963, 'Processor Power Delta_1(kWh)': 75.07577435041182}
[codecarbon DEBUG @ 19:09:11] _get_power_from_cpus - DONT MATCH Processor Energy Delta_0(kWh) : 0.00012791769844518533
[codecarbon DEBUG @ 19:09:11] _get_power_from_cpus - MATCH Processor Power Delta_0(kWh) : 75.0830161810631
[codecarbon DEBUG @ 19:09:11] _get_power_from_cpus - DONT MATCH Processor Energy Delta_1(kWh) : 0.00012790536065753963
[codecarbon DEBUG @ 19:09:11] _get_power_from_cpus - MATCH Processor Power Delta_1(kWh) : 75.07577435041182
[codecarbon INFO @ 19:09:11] Delta energy consumed for CPU with intel_rapl : 0.000256 kWh, power : 150.15879053147492 W
[codecarbon INFO @ 19:09:11] Energy consumed for All CPU : 0.004449 kWh
[codecarbon DEBUG @ 19:09:11] Done measure for CPU - measurement time: 0.0010 s - last call 6.13 s
[codecarbon DEBUG @ 19:09:11] CPU load 180 W x 4.2% = 18.0 for whole machine.
[codecarbon INFO @ 19:09:11] Delta energy consumed for CPU with cpu_load : 0.000031 kWh, power : 18.000000000000004 W
[codecarbon INFO @ 19:09:11] Energy consumed for All CPU : 0.004480 kWh
[codecarbon DEBUG @ 19:09:11] Done measure for CPU - measurement time: 0.0019 s - last call 6.13 s
[codecarbon INFO @ 19:09:11] 0.005751 kWh of electricity used since the beginning.
[codecarbon DEBUG @ 19:09:11] last_duration=6.129475831985474
------------------------

[inimaz]

I arrived to this case. (Testing with Windows machine, but unfortunately I do not have RAPL in this machine and the Intel Power Gadget is not even installed, see #457).
Why remove this else?

[benoit-cty]

Just for testing both mode.

[RafiullahOmar]

Is the "Test under Linux with RAPL" done? @benoit-cty

[benoit-cty]

Is the "Test under Linux with RAPL" done? @benoit-cty

Yes, it's the only one that works for sure.