Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ Configuration precedence and examples: [configuration guide](https://docs.codeca

We created a Python package that estimates your hardware electricity power consumption (GPU + CPU + RAM) and we apply to it the carbon intensity of the region where the computing is done.

CodeCarbon focuses on the main compute components it can measure or estimate directly: CPU, GPU, and RAM. It does not separately model disk I/O, network transfers, displays, cooling, or other peripherals because those sources are usually much smaller for local code-level experiments and are not exposed through the same low-overhead measurement interfaces.

![calculation Summary](docs/images/calculation.png)

We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/latest/explanation/methodology/) section of the documentation.
Expand Down
9 changes: 9 additions & 0 deletions docs/explanation/methodology.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,15 @@ intervals. This is a configurable parameter `measure_power_secs`, with
default value 15 seconds, that can be passed when instantiating the
emissions tracker.

CodeCarbon focuses on the main compute components it can measure or
Comment thread
benoit-cty marked this conversation as resolved.
estimate directly: CPU, GPU, and RAM. It does not separately model disk
I/O, network transfers, displays, cooling, or other peripherals because
those sources are usually much smaller, and often negligible, for local
code-level experiments. They are also not exposed through the same
low-overhead measurement interfaces as CPU, GPU, and RAM. However, they
can matter for workloads dominated by data movement, storage, or
distributed systems.

Currently, the package supports the following hardware infrastructure.

### Tracking Modes
Expand Down
Loading