diff --git a/README.md b/README.md index 08e3135a0..4e61fdf40 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/explanation/methodology.md b/docs/explanation/methodology.md index 673a70c3e..968d55dc1 100644 --- a/docs/explanation/methodology.md +++ b/docs/explanation/methodology.md @@ -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 +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