Skip to content

docs(utilities): live list_samples table + model_diagnostics demo (#915)#960

Open
SaguaroDev wants to merge 55 commits into
casact:experimentalfrom
SaguaroDev:915-utilities-docs
Open

docs(utilities): live list_samples table + model_diagnostics demo (#915)#960
SaguaroDev wants to merge 55 commits into
casact:experimentalfrom
SaguaroDev:915-utilities-docs

Conversation

@SaguaroDev

@SaguaroDev SaguaroDev commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Closes #915.

Two changes to docs/user_guide/utilities.ipynb:

Sample Datasets — the section listed 18 datasets in a hand-maintained markdown table that had drifted out of date. The package now bundles 46. Replaced the static table with a live cl.list_samples() call so the docs render straight from the manifest and can no longer drift.

Model Diagnosticsmodel_diagnostics() is in the public API but was never demonstrated. Added a short section showing it against a fitted Chainladder model.

Verified both code cells execute against the current package (list_samples() returns the 46-row table, model_diagnostics() returns the summary Triangle).


Note

Low Risk
Documentation-only notebook edits with no runtime or API changes.

Overview
Updates the Utilities user guide so sample-dataset and diagnostics docs stay aligned with the package.

Sample Datasets drops the hand-maintained markdown table (18 entries, many stale) in favor of prose pointing to list_samples() and a runnable cell that calls cl.list_samples(), so the rendered table comes from the same manifest as load_sample() and cannot drift as the bundle grows (e.g. 46 datasets).

Model Diagnostics adds a new section with brief API description and a cell that fits Chainladder on raa and calls cl.model_diagnostics(model).

Chainladder Persistence is unchanged in substance; docstrings use single-backtick markdown for API names instead of reStructuredText-style double backticks.

Reviewed by Cursor Bugbot for commit 169923e. Bugbot is set up for automated code reviews on this repo. Configure here.

henrydingliu and others added 30 commits May 27, 2026 22:08
…g_attempt_2

FIX: Make quarterly.csv development dates ISO 8601-compatible.
genedan and others added 19 commits June 8, 2026 15:31
adding support for multi-triangle in mackchainladder
…_diagnostics-(part-1)

fix and enhance utils.model_diagnostics part 1
…_diagnostics-part-2

Fix and enhance utils.model diagnostics part 2
…_diagnostics-part-4

Fix and enhance utils.model diagnostics part 4
…sact#915)

The Sample Datasets section listed 18 datasets in a hand-maintained
markdown table that had drifted out of date; the package now bundles 46.
Replace the static table with a live cl.list_samples() call so the docs
can no longer drift from the manifest.

model_diagnostics was added to the public API but never demonstrated.
Add a Model Diagnostics section showing it against a fitted Chainladder
model.

Closes casact#915.
@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.82%. Comparing base (cdd8371) to head (169923e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #960      +/-   ##
==========================================
- Coverage   88.96%   88.82%   -0.14%     
==========================================
  Files          89       89              
  Lines        5100     5067      -33     
  Branches      663      648      -15     
==========================================
- Hits         4537     4501      -36     
- Misses        417      422       +5     
+ Partials      146      144       -2     
Flag Coverage Δ
unittests 88.82% <ø> (-0.12%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@SaguaroDev

Copy link
Copy Markdown
Contributor Author

The red codecov/project check is base-comparison drift, not anything in this diff. It compares against base commit cdd8371, which is 34 commits behind this branch head, and reads 88.82% (-0.14%) against that stale base. The drop comes from commits that landed on main since, not from this PR.

codecov/patch confirms it: "Coverage not affected when comparing cdd8371...169923e". This is a docs-only notebook edit, so it adds no measurable Python and cannot move coverage.

The Doctest job passes, which is the one that actually executes the edited notebook, so both list_samples() and model_diagnostics() ran clean in CI. Nothing to change in the diff here.

@henrydingliu

Copy link
Copy Markdown
Collaborator

thanks for picking this up.

there's a bug on model_diagnostics. totally my bad for tagging this issue as ready to pick up. will review once that bug fix is approved and merged.

@kennethshsu

Copy link
Copy Markdown
Collaborator

What about here?

@henrydingliu

Copy link
Copy Markdown
Collaborator

What about here?

this page has already been updated. you are pointing to stable, rather than main.

@SaguaroDev SaguaroDev changed the base branch from main to experimental June 12, 2026 19:23
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.

[DOCS] Update user_guide/utilities

5 participants