docs: add a how-it-works overview page - #1382
Open
davidberenstein1957 wants to merge 2 commits into
Open
Conversation
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
davidberenstein1957
marked this pull request as ready for review
August 13, 2026 05:05
davidberenstein1957
requested review from
inimaz
and removed request for
a team
August 13, 2026 05:05
AMD GPUs are read through AMDSMI in codecarbon/core/gpu_amd.py, so 'Nvidia only' understated the measured case. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/explanation/how-it-works.md, the missing one-sitting answer to "how does this actually work?".methodology.mdis now a precise reference — right for an evaluator, wrong for someone meeting the tool. This page carries the mental model: the one-sentence version, the formula once, a measured-vs-modelled table, the carbon-intensity fallback in a paragraph, and routes onward to methodology / accuracy / enable-rapl / references.Also: one nav entry in
mkdocs.yml, one row in thedocs/index.mdlink table.Stacks on #1377 (
docs/methodology-rewrite) — every claim is checked against the rewrittenmethodology.mdon that branch. Merge #1377 first.uv run task docspasses, link checker included.🤖 Generated with Claude Code