docs(utilities): live list_samples table + model_diagnostics demo (#915)#960
docs(utilities): live list_samples table + model_diagnostics demo (#915)#960SaguaroDev wants to merge 55 commits into
Conversation
…urer_grain casact#919 friedland gl self insurer grain
…g_attempt_2 FIX: Make quarterly.csv development dates ISO 8601-compatible.
base.py unit tests
Various friedland fix
…ormatting functions.
Switching codecov to main
Add Slicing tests, annotations.
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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
The red
The Doctest job passes, which is the one that actually executes the edited notebook, so both |
|
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. |
|
What about here? |
this page has already been updated. you are pointing to stable, rather than main. |
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 Diagnostics —
model_diagnostics()is in the public API but was never demonstrated. Added a short section showing it against a fittedChainladdermodel.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 callscl.list_samples(), so the rendered table comes from the same manifest asload_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
Chainladderonraaand callscl.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.