docs: add provenance column to output fields - #1373
Draft
davidberenstein1957 wants to merge 1 commit into
Draft
Conversation
Every CSV column now states what produced it: hardware counter, model, or config. Adds the four EmissionsData fields missing from the table (experiment_id, water_consumed, pue, wue), documents that PUE inflates the per-component energy columns, and corrects the lat/long precision claim (rounding happens only on the API path). 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.
docs/reference/output.mdhad a complete field table that was pure naming: it told you a column is calledcpu_energy, not whether that number came from a RAPL hardware counter or fromcpu_load × TDP. That is the difference between a measurement and an estimate.Changes
file.py:LINE.experiment_id,water_consumed,pue,wue— all on theEmissionsDatadataclass and all written to the CSV, none previously documented. The table now matches the dataclass exactly (checked both directions; nothing documented has been removed from the code).cpu_load/constant), routing to the methodology and accuracy pages.external/ram.py:82-193), with a pointer toforce_ram_power.emissions, including that no column records which level answered.emissions_tracker.py:1194applies PUE to each measurement before accumulation, socpu_energyis not raw CPU energy. Power columns are not scaled, socpu_energy != cpu_power × durationwhenpue != 1. Previously undocumented anywhere.latitude/longitudeare written at full precision in the CSV — the old table claimed reduced precision, but the rounding atcore/api_client.py:246applies only to the API path.Verification
uv run task docspasses (zensical build + link check).Item 3 of the methodology overhaul plan. Scoped to
docs/reference/output.mdonly.🤖 Generated with Claude Code