docs: reposition around distributional regression - #22
Merged
Conversation
The docs led with "Boost every parameter", which is not a statistical term and read as a slogan rather than a claim. Retitle everything around distributional regression and varying-coefficient models, the established names for what NaturalBoost/WeibullAFT and FormulaBoost actually fit, and state the differentiator plainly: the full K x K natural gradient rather than a diagonal approximation. Slim the README to a lean overview that links out for detail, and stop leading with the NGBoost speedup ratio on every pitch surface, since the suite is still incomplete: three UCI datasets are unmeasured, and XGBoostLSS and LightGBMLSS are not compared at all. The measured ratio now lives only on the benchmarks and GPU pages. Comparison sections describe what each library targets instead of what it cannot do. New pages: benchmarks, how-it-works, formulaboost, survival. Em dashes removed throughout. Co-authored-by: Cursor <cursoragent@cursor.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
Summary
NaturalBoost/WeibullAFTandFormulaBoostactually fit. The previous framing ("Boost every parameter") was not a statistical term and read as a slogan. The differentiator is now stated plainly: the fullK x Knatural gradient rather than a diagonal approximation.docs/benchmarks.md, which is now the source of truth the README summarizes.n/a, list labels took colons, and prose cases became commas, semicolons, or new sentences.New pages:
docs/benchmarks.md,docs/user-guide/how-it-works.md,docs/user-guide/formulaboost.md,docs/user-guide/survival.md.No behavior changes. The only source edits are docstrings, plus the
pyproject.tomldescription and keywords.Test plan
uv run mkdocs buildcompletes with no errors or broken linksREADME.md,docs/,CLAUDE.md,CHANGELOG.md, orexamples/README.mdimport openboostsucceeds and the rewritten package docstring rendersdocs/benchmarks.mdmatch the committed Modal runsMade with Cursor