You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -224,7 +224,7 @@ Then run opened test with this button:
224
224
<!-- TOC --><aname="coding-style-linting"></a>
225
225
### Coding style && Linting
226
226
227
-
The coding style and linting rules are automatically applied and enforced by [pre-commit](https://pre-commit.com/). This tool helps to maintain the same code style across the code-base such to ease the review and collaboration process. Once installed ([https://pre-commit.com/#installation](https://pre-commit.com/#installation)), you can install a Git hook to automatically run pre-commit (and all configured linters/auto-formatters) before doing a commit with `uv run precommit-install`. Then once you tried to commit, the linters/formatters will run automatically. It should display something similar to:
227
+
The coding style and linting rules are automatically applied and enforced by [pre-commit](https://pre-commit.com/). This tool helps to maintain the same code style across the code-base such to ease the review and collaboration process. Once installed ([https://pre-commit.com/#installation](https://pre-commit.com/#installation)), you can install a Git hook to automatically run pre-commit (and all configured linters/auto-formatters) before doing a commit with `uv run task precommit-install`. Then once you tried to commit, the linters/formatters will run automatically. It should display something similar to:
228
228
229
229
```log
230
230
[INFO] Initializing environment for https://github.com/psf/black.
Copy file name to clipboardExpand all lines: docs/edit/rapl.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ Different CPUs expose different domains. Common domains include:
60
60
- Ring interconnect between cores
61
61
- Integrated GPU (if present)
62
62
63
-
- **dram**: Memory controller power (rare on consumer hardware, more common on servers)
63
+
- **dram**: Memory controller power, rare on consumer hardware, more common on servers. We still have to figure out if it is accurate.
64
64
65
65
- **gpu**: Discrete or integrated GPU (when available)
66
66
@@ -111,7 +111,7 @@ CodeCarbon implements intelligent domain selection to provide reliable and consi
111
111
112
112
4. **Subdomain filtering**: Excludes ``core`` and ``uncore`` subdomains when ``package`` is available to avoid double-counting
113
113
114
-
5. **DRAM inclusion**: By default (``include_dram=True``), adds DRAM domain to package for complete hardware power measurement
114
+
5. **DRAM exclusion**: By default (``include_dram=False``), don't adds DRAM domain to package. As DRAM is supposed to be in RAM power, not CPU in a future version of CodeCarbon.
115
115
116
116
Platform-Specific Behavior
117
117
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -334,17 +334,17 @@ Key Takeaways for RAPL Measurements
334
334
335
335
5. **Interface deduplication**: The same domain may appear in both ``intel-rapl`` (MSR) and ``intel-rapl-mmio`` interfaces. CodeCarbon automatically deduplicates, preferring MMIO.
336
336
337
-
6. **DRAM measurement**: CodeCarbon includes DRAM domains by default (``include_dram=True``) for complete hardware measurement (CPU package + memory). Set ``include_dram=False`` to measure only CPU package.
337
+
6. **DRAM measurement**: CodeCarbon does not include DRAM domains by default (``include_dram=False``) for CPU hardware measurement. Set ``include_dram=True`` to measure CPU package + DRAM domains.
338
338
339
339
7. **Platform-specific behavior**:
340
340
341
-
- Intel modern: package + dram (default) or psys (with prefer_psys=True)
341
+
- Intel modern: package or psys (with prefer_psys=True)
342
342
- Intel older: package-0 for CPU only
343
343
- AMD: Sum all package-X-die-Y for multi-die CPUs
344
344
345
345
8. **Limitations**: RAPL does NOT measure:
346
346
347
347
- Discrete GPUs (use nvidia-smi/rocm-smi)
348
348
- SSDs, peripherals, fans
349
-
- Actual DRAM chips (only memory controller on CPU)
349
+
- Actual DRAM chips, we still have to investigate on this point
350
350
- Complete system power (use wall meter for accuracy)
0 commit comments