Repository navigation
Fix SDF checkpoint documentation - #32
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request updates the documented Stochastic Discount Factor (SDF) checkpoint schedule to match the validator’s n_epochs_cond=1024 constraint, switches published defaults to the phase-aware final conditional checkpoint, and adds a test that validates documented SDF checkpoint configurations directly from markdown sources.
Changes:
- Update README + docs examples to remove conditional checkpoint epochs above 1024 and set
default_checkpoint=("conditional", 1024)where appropriate. - Add a test that parses markdown
pythoncode blocks and instantiatesStochasticDiscountFactorConfigfrom documented checkpoint settings. - Ensure wheel CI test environment includes documentation files needed by the new documentation-validation test.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_examples.py | Adds a markdown code-block scan to validate documented StochasticDiscountFactorConfig checkpoint settings. |
| scripts/ci/test_wheel.py | Copies README + docs into the wheel test sandbox so doc-based tests can run. |
| README.md | Corrects the documented SDF checkpoint_epochs schedule (removes invalid 1280 conditional epoch). |
| docs/user-guide/stochastic-discount-factor.md | Updates example checkpoint schedule and uses phase-aware default_checkpoint=("conditional", 1024). |
| docs/getting-started/quickstart.md | Updates quickstart SDF config defaults to the phase-aware final conditional checkpoint. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
What changed
Why
The stable validator correctly rejects conditional checkpoint epochs above
n_epochs_cond=1024, but three published examples included1280as a conditional phase epoch and configured default. The cumulative legacy label1280remains valid when selecting an already fitted checkpoint.Validation
ty checkpassed