Repository navigation
Docs: runnable model tasks and verified book links - #53
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.
A reader can run a bounded PCA forecast from the README or Quickstart using the base wheel, verify finite output with shape (2, 6), and follow task guides to generated API signatures and pinned public teaching files. Seven runnable examples cover factor forecasting, SDF, direct asset prediction, portfolio learning and downstream handoffs.
Closes #52.
Document optional dependencies and training limits explicitly. Distinguish book notebooks that teach related methods from the case-study bridge that calls ml4t.models. All ten linked files exist at companion revision d2edec54b1c7a6a9d7a97d8129eb05db4491e1eb.
Replace dense embedded diagrams with shared HTML that reflows with the article. At 375px and 1440px, figure and table labels measure 14.44px beside 15.2px prose, without figure or page overflow. A browser check rejects a real rebuilt stylesheet regression producing 30.4px labels and passes after restoring the intended stylesheet. The mobile navigation menu also works.
Local verification includes strict MkDocs, runnable examples from clean installed wheels outside the source checkout, rendered local links, Ruff, ty and native commit hooks. The combined candidate passes 466 source tests and 426 installed-wheel tests with NumPy-only and full optional-dependency environments. Book datasets and full research training are not rerun.
At 94d05ab against merged main 370b046, all 33 applicable hosted checks pass, including the source and installed-wheel platform matrices, dependency audit, Python 3.15 prerelease, strict documentation and MPS qualification. Two jobs skip under configured conditions, including the main-only CUDA/performance job.
AI assistance: Codex prepared, reviewed and verified the documentation changes. No documentation deployment or package release is performed by this PR.