Refresh README with current toolkit capabilities - #7
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository README to reflect the toolkit’s currently implemented surface area (walk-forward splits, data manifests, expanded diagnostics scope) and refreshes the minimal usage snippet accordingly.
Changes:
- Expanded the capability summary to include walk-forward splits and dataset manifests.
- Updated the Showcase description to reflect the current diagnostics/report contents.
- Refreshed the Minimal API example to use top-level imports and demonstrate walk-forward splitting + manifest creation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Showcase | ||
|
|
||
| - [Example Diagnostics Report](reports/example-diagnostics.md): a compact demo table with Rank IC, turnover, gross return, net return, and verdict. | ||
| - [Example Diagnostics Report](reports/example-diagnostics.md): a compact demo with Rank IC, turnover, gross return, net return, rejection verdict, walk-forward split checks, and data manifest boundaries. |
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.
Updates the README to reflect the current implemented toolkit surface:
No source code changed in this PR.