Repository navigation
Refine portfolio documentation and package readiness - #4
Merged
Merged
Conversation
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.
Make the repository easier to assess and run: the README now explains the single-worker scheduling problem, the rule-selection workflow, and the observed experimental tradeoffs before the setup commands.
Validation: all 81 tests, Ruff lint/format, and strict mypy passed on Python 3.10.22 and 3.12.14. Wheels built on both versions, included the MIT license, and ran both CLI entry points outside the checkout. A fresh core installation ran without Matplotlib. Documented training, evaluation, help, and benchmark commands ran successfully; the temporary benchmark reproduced all nine committed reference artifacts byte-for-byte. All local documentation links/anchors and README result values were checked against committed files.
The six-file change contains documentation and packaging/CI settings. Scheduling code, reference outputs, and saved Q-tables retain their existing contents. The repository remains private.