Repository navigation
docs: qualify tutorial claims and simplify wording - #210
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
The introductions and worked guides used promotional comparisons, universal performance claims and statements that could imply a Pareto front or a second simulation phase establishes scientific validity. Replace these with concrete descriptions and results scoped to the evaluated configurations.
Simplify the README and documentation overview. Clarify Pareto dominance, distinguish predictive scores from calibration, remove unsupported timing and optimizer comparisons, and describe the monitoring model as a simplified observation model. Keep equations, algorithms and runnable examples unchanged.
Validation:
just format,just check,just ci,just doctestanduv run mkdocs build --strictpassed. The full suite has 883 passing tests with 95.25% coverage. No runtime, dependency or version change.