mlco2 / codecarbon

Track emissions from Compute and recommend ways to reduce their impact on the environment.
https://mlco2.github.io/codecarbon
MIT License
1.12k stars 173 forks source link

Error in documentation for output? #420

Closed NickESouter closed 11 months ago

NickESouter commented 1 year ago

Description

On the 'output' page of the documentation (https://mlco2.github.io/codecarbon/output.html), energy use is described as being reported in kW. However, from my experience using CodeCarbon as it is integrated with fMRIPrep (https://fmriprep.org/en/stable/changes.html#december-12-2022) I believe that the output is actually report in kWh. Is it possible that this is an error in the documentation?

Thanks!

LukasFehring commented 1 year ago

Additionally, in version 2.2.4 the metric pue is returned, but not explained in the output parameters

benoit-cty commented 1 year ago

You are right, indeed energy is in kWh and power in W.

Thanks for informing us of your usage, impressive project !

LuisBlanche commented 11 months ago

This was fixed by 9c5de172885a7bd36f3404ab8d5e483b817d3c4c