Skip to content

Add 7 example docs covering full API surface (~130 functions)#11

Merged
sipemu merged 1 commit intomainfrom
feature/docs-full-api-coverage
Feb 24, 2026
Merged

Add 7 example docs covering full API surface (~130 functions)#11
sipemu merged 1 commit intomainfrom
feature/docs-full-api-coverage

Conversation

@sipemu
Copy link
Contributor

@sipemu sipemu commented Feb 24, 2026

Summary

  • 7 new example pages with runnable code, expected outputs, and plots covering ~100 previously undocumented functions:
    • Regularized & Specialized Models (lasso, WLS, RLS, BLS, NNLS, isotonic, ridge, elastic net)
    • Generalized Linear Models (Poisson, negative binomial, Tweedie, probit, cloglog)
    • Special Models (ALM robust regression, AID demand classification, dynamic regression)
    • Equivalence Testing — complete TOST guide (all 8 variants)
    • Categorical Data Analysis (binomial, chi-square, G-test, McNemar, Cohen's kappa, phi, contingency)
    • Forecast Model Comparison (Diebold-Mariano, Clark-West, SPA, MCS, energy distance, MMD)
    • Advanced Correlation & Reliability (distance correlation, semi-partial/partial, D'Agostino)
  • 3 existing pages edited: added D'Agostino section to hypothesis-testing, cross-references to regression-workflow and ab-testing
  • 17 new plots added to gen_plots.py (34 total PNGs), no scipy/sklearn dependencies
  • mkdocs.yml nav updated with all new pages
  • mkdocs build verified clean

Test plan

  • uv run python docs/assets/gen_plots.py generates all 34 PNGs without error
  • uv run --with mkdocs-material mkdocs build succeeds
  • Spot-check code examples in each new page against actual polars_statistics output
  • Verify cross-reference links between pages resolve correctly

🤖 Generated with Claude Code

New pages: regularized-regression, glm-models, special-models,
equivalence-testing, categorical-analysis, forecast-comparison,
and advanced-correlation. Updated hypothesis-testing (D'Agostino),
regression-workflow and ab-testing (cross-refs), mkdocs.yml nav,
and gen_plots.py (17 new plots, 34 total PNGs).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sipemu sipemu merged commit d412d0e into main Feb 24, 2026
17 checks passed
@codecov
Copy link

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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