Skip to content

docs: reposition around distributional regression - #22

Merged
jxucoder merged 1 commit into
mainfrom
docs/reposition-distributional-regression
Aug 18, 2026
Merged

docs: reposition around distributional regression#22
jxucoder merged 1 commit into
mainfrom
docs/reposition-distributional-regression

Conversation

@jxucoder

Copy link
Copy Markdown
Owner

Summary

  • Retitles the docs around distributional regression and varying-coefficient models, the established names for what NaturalBoost/WeibullAFT and FormulaBoost actually fit. The previous framing ("Boost every parameter") was not a statistical term and read as a slogan. The differentiator is now stated plainly: the full K x K natural gradient rather than a diagonal approximation.
  • Slims the README from 182 to 128 lines. The four benchmark tables move to a new docs/benchmarks.md, which is now the source of truth the README summarizes.
  • Stops leading with the NGBoost speedup ratio on pitch surfaces, because the suite is incomplete: three UCI datasets are unmeasured, and XGBoostLSS/LightGBMLSS are not compared at all. The measured ratio now appears only on the benchmarks and GPU-setup pages, and the README states its own limits.
  • Comparison sections describe what each library targets rather than what it cannot do ("How it compares" replaces "Why not NGBoost or XGBoost").
  • Removes em dashes throughout (roughly 90 occurrences), rewriting each rather than substituting, so table placeholders became 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.toml description and keywords.

Test plan

  • uv run mkdocs build completes with no errors or broken links
  • All three README code snippets executed against the CPU backend and produce the documented shapes and keys
  • No em dashes remain in README.md, docs/, CLAUDE.md, CHANGELOG.md, or examples/README.md
  • import openboost succeeds and the rewritten package docstring renders
  • Reviewer check: benchmark claims in docs/benchmarks.md match the committed Modal runs

Made with Cursor

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>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@jxucoder
jxucoder merged commit 6ebe3a8 into main Aug 18, 2026
4 checks passed
@jxucoder
jxucoder deleted the docs/reposition-distributional-regression branch August 18, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant