Skip to content

Commit afa3ac8

Browse files
authored
Merge pull request #1204 from zhouzhou626/docs/document-hardware-scope-154
Document hardware measurement scope
2 parents b8eb900 + ad4c52d commit afa3ac8

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ Configuration precedence and examples: [configuration guide](https://docs.codeca
7676

7777
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.
7878

79+
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.
80+
7981
![calculation Summary](docs/images/calculation.png)
8082

8183
We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/latest/explanation/methodology/) section of the documentation.

docs/explanation/methodology.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,15 @@ intervals. This is a configurable parameter `measure_power_secs`, with
8585
default value 15 seconds, that can be passed when instantiating the
8686
emissions tracker.
8787

88+
CodeCarbon focuses on the main compute components it can measure or
89+
estimate directly: CPU, GPU, and RAM. It does not separately model disk
90+
I/O, network transfers, displays, cooling, or other peripherals because
91+
those sources are usually much smaller, and often negligible, for local
92+
code-level experiments. They are also not exposed through the same
93+
low-overhead measurement interfaces as CPU, GPU, and RAM. However, they
94+
can matter for workloads dominated by data movement, storage, or
95+
distributed systems.
96+
8897
Currently, the package supports the following hardware infrastructure.
8998

9099
### Tracking Modes

0 commit comments

Comments
 (0)