docs: foreground benchmark evidence - #13
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a concise “benchmark evidence” section to the top-level README to summarize revision-2 results and reinforce the research-only (non-deployment) scope, including a committed primary figure and provenance links for auditability.
Changes:
- Added a “What this benchmark demonstrates” overview with key synthetic + historical outcome summaries.
- Embedded the primary revision-2 results figure and linked it to the manifest and audit trail.
Suppressed comments (1)
README.md:39
- The text alternates between “revision 2” and “revision-2”. For consistency (and easier searching), it would help to stick to the same spelling as the section heading (“revision 2”).
*Primary result snapshot from the committed revision-2 bundle, generated by
the [`voltrl_benchmark.py`](voltrl_benchmark.py) command below. Panel A shows
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+25
to
+32
| VoltRL is an auditable research benchmark under two explicit information | ||
| protocols, not a live-trading or deployment system. Across 30 regenerated | ||
| synthetic datasets, seasonal autoregressive (SARX) 24-hour MPC has the highest | ||
| mean annualized adjusted profit (EUR 5.13M; 95% bootstrap CI EUR 5.05–5.23M), | ||
| versus EUR 4.62M for the hour-aware finite-horizon MDP (EUR 4.51–4.73M). | ||
| Historical DK1/DK2 schedules are fixed before delivery and use realized prices | ||
| only for settlement; SARX reports EUR 0.129M and EUR 0.187M annualized adjusted | ||
| profit, respectively, after modeled degradation. These protocol-bound results |
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
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.
Summary: Add a concise benchmark-results overview, explicit research-versus-deployment boundary, and the committed primary revision-2 figure with provenance links. Validation: 67 unit tests, five result-bundle audit checks, Markdown links, and diff check.