notebooks: PRT work pt1#509
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Nice work! My agent helped me check with these comments 😄 Must-fix (blocking or near-blocking)
Should-fix (quality / consistency)
Nice-to-have / pre-existing |
|
@jamadriz Fixes applied in commit #c0206e6 All four review items from PR #509's comment are applied. Summary of the diff (54 files):
|
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>
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 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>
Pull Request Description
What and why?
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:
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.ipynb→1-run_dataset-based_tests.ipynbnotebooks/how_to/tests/run_tests/2_run_comparison_tests.ipynb→2-run_comparison_tests.ipynbnotebooks/tutorials/validation/3-developing_challenger_model.ipynb→3-developing_potential_challenger.ipynbAll associated PNGs/GIFs and
lr_model_champion.pkl/xgb_model_champion.pklmoved with their notebooks.Repo-side updates to match the renames
.gitignore— updated!notebooks/...allowlist entries for the moved.pklfixtures.scripts/run_e2e_notebooks.py— updatedquickstart_model_documentation.ipynbpaths toquickstart_documentation.ipynb(in bothNOTEBOOKS_TO_RUNandDATA_TEMPLATE_NOTEBOOKS).README.md,README.pypi.md,r/validmind/README.md— updated the R.Rmdfilenames 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?
Dependencies, breaking changes, and deployment notes
Release notes
n/a
Checklist