Skip to content

notebooks: PRT work pt1#509

Merged
validbeck merged 70 commits into
mainfrom
beck/sc-15850/documentation-primary-record-types-notebooks
May 19, 2026
Merged

notebooks: PRT work pt1#509
validbeck merged 70 commits into
mainfrom
beck/sc-15850/documentation-primary-record-types-notebooks

Conversation

@validbeck

@validbeck validbeck commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

sc-15850

Updating the notebooks to reflect the new PRT functionality in parts. This part covers mainly conceptual edits of the notebooks, primarily the tutorials and quickstarts that get surfaced in guides in the documentation.

Important

Refer to "What needs special review?" for the parts that have yet to be updated.

Terminology refresh examples

Almost every notebook had its prose normalized:

  • "model risk management" → "risk management"
  • "model documentation" → "documentation"
  • "documenting models" → "documenting records such as models"
  • "model validators" → "validators"

Directory & file renames

  • notebooks/tutorials/model_development/notebooks/tutorials/development/
  • notebooks/tutorials/model_validation/notebooks/tutorials/validation/
  • notebooks/use_cases/model_validation/notebooks/use_cases/validation/
  • notebooks/quickstart/quickstart_model_documentation.{ipynb,Rmd}quickstart_documentation.{ipynb,Rmd}
  • notebooks/quickstart/quickstart_model_validation.{ipynb,Rmd}quickstart_validation.{ipynb,Rmd}
  • notebooks/how_to/tests/run_tests/1_run_dataset_based_tests.ipynb1-run_dataset-based_tests.ipynb
  • notebooks/how_to/tests/run_tests/2_run_comparison_tests.ipynb2-run_comparison_tests.ipynb
  • notebooks/tutorials/validation/3-developing_challenger_model.ipynb3-developing_potential_challenger.ipynb

All associated PNGs/GIFs and lr_model_champion.pkl / xgb_model_champion.pkl moved with their notebooks.

Repo-side updates to match the renames

  • .gitignore — updated !notebooks/... allowlist entries for the moved .pkl fixtures.
  • scripts/run_e2e_notebooks.py — updated quickstart_model_documentation.ipynb paths to quickstart_documentation.ipynb (in both NOTEBOOKS_TO_RUN and DATA_TEMPLATE_NOTEBOOKS).
  • README.md, README.pypi.md, r/validmind/README.md — updated the R .Rmd filenames and added a pointer to the PII detection how‑to notebook.

Stale URL fixes

Any existing renames from the documentation side have been updated in this PR to clean up redirects out to the guides.

How to test

Pull the PR down and spot check some notebooks, keeping in mind the special review section.

What needs special review?

  • Notebooks I've already thoroughly edited got a more thorough pass of terminology. If you notice a notebook looks incomplete, it's probably because it's still on the list for style/accuracy edits.
  • KEY CONCEPTS HAS NOT BEEN UPDATED IN ANY NOTEBOOK YET. I need to update them in the docs site side to make things consistent before replicating in notebooks. Story is tracked under 15992 in Shortcut.

Dependencies, breaking changes, and deployment notes

Release notes

n/a

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@validbeck validbeck self-assigned this May 15, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 15, 2026
@validbeck validbeck requested review from even-steven and jamadriz May 15, 2026 02:17
@jamadriz

Copy link
Copy Markdown
Contributor

Nice work! My agent helped me check with these comments 😄


Must-fix (blocking or near-blocking)

  1. README typo: “PPI” instead of “PII”
    The new link text says “Enable PPI detection”; it should be PII (personally identifiable information).
    README.md
    Lines 70-70
    For an extended guide, refer to our how-to notebook: Enable PPI detection

Should-fix (quality / consistency)
2. Double space after “collaborate on”
Many notebooks/templates now contain collaborate on documentation (two spaces). That almost certainly comes from replacing “model documentation” with “documentation” while leaving an extra space. It reads as a typo in rendered HTML and shows up in many files (quickstarts, templates, how-tos, use cases). A repo-wide replace of on documentation → on documentation (or a fuller phrase like “on documentation for your records”) would clean this up.

  1. GitHub “bidirectional / hidden Unicode” warning
    GitHub flagged hidden or bidirectional Unicode in at least one file in the PR thread. Worth running a targeted scan (or opening the flagged file in an editor that shows hidden characters) so nothing odd ships in prose or URLs.

Nice-to-have / pre-existing
4. application_scorecard_demo.ipynb in DATA_TEMPLATE_NOTEBOOKS
scripts/run_e2e_notebooks.py still points at notebooks/use_cases/credit_risk/application_scorecard_demo.ipynb, which does not exist in the tree (only application_scorecard_full_suite.ipynb, _with_ml, etc.). That path is already wrong on main; this PR did not introduce it. Still worth a separate small fix so e2e template runs do not reference a missing notebook.

@jamadriz jamadriz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please see comment

@validbeck

validbeck commented May 15, 2026

Copy link
Copy Markdown
Collaborator Author

@jamadriz Fixes applied in commit #c0206e6

All four review items from PR #509's comment are applied. Summary of the diff (54 files):

Item Files Change
1. PPI → PII README.md Link text fix on line 70
2. Double-space collapse 51 notebooks + Rmd on documentationon documentation (one-occurrence-per-file replacement; all 51 hits were the same "collaborate on documentation. Together,…" sentence)
3. Hidden Unicode notebooks/tutorials/development/4-finalize_testing_documentation.ipynb Removed single U+200B before **ValidMind Insights** on line 909
4. Missing scorecard demo scripts/run_e2e_notebooks.py application_scorecard_demo.ipynbapplication_scorecard_full_suite.ipynb in DATA_TEMPLATE_NOTEBOOKS

@validbeck validbeck requested a review from jamadriz May 15, 2026 19:52
@validbeck validbeck merged commit 4f349a8 into main May 19, 2026
7 checks passed
@validbeck validbeck deleted the beck/sc-15850/documentation-primary-record-types-notebooks branch May 19, 2026 16:14
validbeck added a commit that referenced this pull request May 21, 2026
Replay of ef4dba7 + aa4ab2e + 055042e on fresh main, accounting for
PR #509 file renames. Updates the developer-framing Key concepts block
to the new record/model/document terminology across 30 Jupyter
notebooks and 1 R notebook. Includes the cross-framing swap for
qualitative_text_generation.ipynb and the structural restructure (with
preserved architecture images) for use_dataset_model_objects.ipynb.
TOC anchors preserved where present.

Co-authored-by: Cursor <cursoragent@cursor.com>
validbeck added a commit that referenced this pull request May 21, 2026
Replay of 4ae2f0a on fresh main, accounting for PR #509 file renames.
Updates the validator-framing Key concepts block to the new
record/model/validation report terminology across 4 validator notebooks
(_about-validmind-validators, quickstart_validation,
1-set_up_validmind_for_validation, validate_application_scorecard).
Adds the new `artifacts (findings)` term. TOC anchor preserved on
validate_application_scorecard.ipynb.

Co-authored-by: Cursor <cursoragent@cursor.com>
validbeck added a commit that referenced this pull request May 26, 2026
* Replace developer-framing Key concepts across 31 notebooks

Replay of ef4dba7 + aa4ab2e + 055042e on fresh main, accounting for
PR #509 file renames. Updates the developer-framing Key concepts block
to the new record/model/document terminology across 30 Jupyter
notebooks and 1 R notebook. Includes the cross-framing swap for
qualitative_text_generation.ipynb and the structural restructure (with
preserved architecture images) for use_dataset_model_objects.ipynb.
TOC anchors preserved where present.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Replace validator-framing Key concepts across 4 notebooks

Replay of 4ae2f0a on fresh main, accounting for PR #509 file renames.
Updates the validator-framing Key concepts block to the new
record/model/validation report terminology across 4 validator notebooks
(_about-validmind-validators, quickstart_validation,
1-set_up_validmind_for_validation, validate_application_scorecard).
Adds the new `artifacts (findings)` term. TOC anchor preserved on
validate_application_scorecard.ipynb.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Replace monitoring-framing Key concepts across 3 notebooks

Replay of 421200b on fresh main. Updates the monitoring-framing Key
concepts block to the new record/model/ongoing monitoring report
terminology across 3 monitoring notebooks (_about-validmind-monitoring,
application_scorecard_ongoing_monitoring,
quickstart_customer_churn_ongoing_monitoring). Adds the new
`ongoing monitoring report` and `monitoring template, monitoring
report template` terms. TOC anchors preserved where present.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Edit for beck/sc-15992/documentation-primary-record-types-glossary

* oops

* Updating key concepts for SR 26-2

* Edit #1

* Edit #2

* Edit #3

* ...

* hdfkg

* esfhjks

* omg

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants