Add a reader-facing statement of what this repository can and cannot do - #424
Open
stefan-jansen wants to merge 1 commit into
Open
Add a reader-facing statement of what this repository can and cannot do#424stefan-jansen wants to merge 1 commit into
stefan-jansen wants to merge 1 commit into
Conversation
docs/what-this-is.md sorts the repository into four levels - reproduce with one command, modify with a config edit, needs real infrastructure, not promised - so a reader can decide what to attempt before installing anything. Linked from the README's Quick Start as the first of three onboarding docs. Rebuilt onto current main rather than merged: the original branch was 20 commits behind and its diff against main was mostly staleness. The real delta is these two files, and main's own README changes (61 skills, the Maven workshop, cover.png) are untouched - the two sides edit different regions. Two claims softened from the original draft, both because the stronger form is not true: the page no longer says every printed case-study result reproduces without training, and no longer says the analysis notebooks only read registered results. Several of them recompute cost cascades, risk overlays and portfolio statistics from the downloaded artifacts, so a figure there can differ from the printed one with nothing retrained - sp500_options/14_costs is a live example. Every path, flag and cross-reference verified against main: the four linked docs resolve, the running-notebooks anchor exists, --free-only / --skip-firm-characteristics / --cs are real, and the three config paths match the actual layout. The GPU claims match what CI measures - the four named crypto notebooks do hard-raise without CUDA.
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 this is
docs/what-this-is.mdsorts the repository into four levels — reproduce with one command, modify with a config edit, needs real infrastructure, not promised — so a reader can decide what to attempt before installing anything. Linked from the README's Quick Start as the first of three onboarding docs.Rebuilt, not merged
The original
docs/reader-experimentsbranch was 20 commits behindmainand its diff againstmainwas 96 files / 14,768 deletions — almost all staleness. The real delta is two files.main's own README changes (61 skills, the Maven workshop link,cover.png) are untouched; the two sides edit different regions and merged cleanly.Two claims softened from the draft
Both because the stronger form is not true:
Now: the results download, so you can reach them without training.
Now: they read registered results instead of retraining, but several still recompute cost cascades, risk overlays and portfolio statistics from the downloaded artifacts — so a figure there can differ from the printed one with nothing retrained.
sp500_options/14_costsis a live example of exactly that. Overstating this is the failure mode a page like this has, so it is worth being narrow.This follows three earlier overstatements a review already caught on this page (that every book result reproduces without training, that GPU families run on CPU, and that any listed preset gets trained).
Verification
Every path, flag and cross-reference checked against
main, because each one is something a reader will type:docs/running-notebooks.md,docs/installation.md,envs/README.md,data/README.mdall resolve; the#experimenting-without-changing-the-release-baselineanchor exists (running-notebooks.md:297).--free-only,--skip-firm-characteristics,--csare all real flags.01_process_is_edge/factor_regimes.py,scripts/download_artifacts.py,case_studies/etfs/13_model_analysis.py,18_strategy_analysis.pyexist.case_studies/{cs}/config/setup.yaml,config/training/{label}.yaml,case_studies/config/{model_type}/).crypto_perps_fundingnotebooks do hard-raisewithout CUDA, and theus_firm_characteristicsdeep notebooks are GPU-marked (Mark the us_firm GPU notebooks GPU-only and skip the cache-only IPCA replay #415).Docs only — no CI job's result should move.