docs(naming): stop overstating Alpha158 / causal chains / IC (P1.5)#62
Merged
Conversation
Closes #51 (P1.5). Documentation/label honesty only — no behavior change: - "Qlib Alpha158" → "Qlib custom alpha factors" in README, dev-guide, and the qlib_alpha docstring. It is a hand-written ~20-factor set in the Qlib DSL, NOT Qlib's 158-factor Alpha158 dataset handler. - impact_chain: documented as hand-authored keyword-matched transmission TEMPLATES (a curated rule base with fixed confidences), not statistically inferred causality. - qlib_worker IC: annotated both call sites that the value is a serial return autocorrelation proxy, NOT a true cross-sectional Information Coefficient (the "ic" key is kept for config/back-compat). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Jcstack
enabled auto-merge (squash)
June 25, 2026 17:07
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
1 participant
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.
Closes #51. Documentation/label honesty only — no behavior change.
README, dev-guide, and theqlib_alphadocstring now say "Qlib custom alpha factors". It is a hand-written ~20-factor set in the Qlib DSL, not Qlib's 158-factorAlpha158dataset handler (which the code never instantiates).impact_chainis documented as hand-authored, keyword-matched transmission templates (a curated rule base with fixed confidences) — not statistically inferred causality.qlib_workercall sites are annotated that the value is a serial return autocorrelation proxy, not a true cross-sectional Information Coefficient. The"ic"key is kept for config/back-compat.ruffclean; imports + 69 quant/intelligence tests green. Simulation-only; not investment advice.