23.03.05

What's Changed

Internal

• Release notes to sprint 68 — 25.02 by @validbeck in #666
• Developer portal — Quick reshuffle to accomodate "ValidMind for model development" series by @validbeck in #668
• feat: example implementation of trigger in other repo by @nibalizer in #672
• Remove defunct deploy-demo make action by @nrichers in #678
• feat: extend build to include private section by @nibalizer in #677
• Enable cloning at a specific release tag by @nrichers in #676
• Add URL configuration to Docker images by @nrichers in #674 (Customer-managed ValidMind only)

External

• Switch Python API reference to Quarto by @nrichers in #640

Full Changelog: 25.02...23.03.05

25.02

What's Changed

This release focuses on quality of life improvements for our users: ValidMind Academy training journeys and transparent history for breaking changes and deprecations.

Internal

• Updated documentation for Metrics Over Time by @validbeck in #633
• Edits to Export documentation for validation reports by @validbeck in #635
• Release notes to Sprint 66 (25.01) by @nrichers in #634
• Wrapping "Add context to LLM-generated test descriptions" into docs by @validbeck in #643
• Adding latest RawData notebook to docs by @validbeck in #647
• Fix notebook link by @nrichers in #651
• feat: make lighter version of docs-site target by @nibalizer in #653
• • breaking-change releases tag, PR template, & release script update by @validbeck in #659
• Update work-with-content-blocks.qmd by @fenakaza1 in #663
• Removed references to editions in FAQ by @validbeck in #662

External

• Define next iteration of training content by @nrichers in #649
• Part 1 — +"Breaking changes and deprecation" page under releases to support the new processes by @validbeck in #650

New Contributors

• @nibalizer made their first contribution in #653
• @fenakaza1 made their first contribution in #663

Full Changelog: 25.01...25.02

25.01

Documentation releases now follow the new unified versioning scheme for our software releases rather than following the ValidMind Library version, starting with this 25.01 release.

Why change the versioning scheme?

We maintain multiple repositories, each with its own version tags. With the new versioning scheme, we can now provide a single unified release version, such as 25.01, that represents a collection of releases from these individual repositories. This ensures consistency and makes it easier to track and reference all changes associated with a specific release. Each unified version corresponds to updates across several repositories, simplifying version management for you.

This change does not affect how frequently new releases occur (release cadence) or the process you follow to upgrade. Only the versioning scheme for documentation has been updated. Everything else stays the same.

What's Changed

• Docs quick audit — ValidMind Library by @validbeck in #593
• Add Docker image for our docs site by @nrichers in #594
• Cleaned up Developer Fundamentals & other training by @validbeck in #599
• Delete test-results directory by @nrichers in #600
• Release notes — December 24, 2024 by @validbeck in #596
• Edited release script & notebook by @validbeck in #607
• Cleanup of 2024 releases + new cleanup notebook/script by @validbeck in #610
• Missing footnote from FAQ by @validbeck in #613
• Pulling in latest changes from validmind-library PR#282 by @validbeck in #615
• Add make execute PROFILE=exe-prod to docs-site action by @nrichers in #598
• Docs — Customize model overview page by @validbeck in #622
• Updated docs — Workflows by @validbeck in #620
• QoL improvements to release notes script/notebooks by @validbeck in #626
• Added instructions for Wait steps in workflows by @validbeck in #628
• Updated mathematical formula support for content blocks by @validbeck in #631

Full Changelog: v2.6.7...25.01

v2.6.7

What's Changed

This release includes updated training collateral for developers, a new ValidMind Platform login button, a support chatbot, and revamped FAQs.

Internal

• Docs — Custom reporting by @validbeck in #533
• Added quick instructions on submitting feedback within the platform by @validbeck in #540
• Live execution of intro_for_model_developers_EXECUTED.ipynb by @validbeck in #528
• Replace Output Template Notebook from Highlighted Code Samples by @johnwalz97 in #539
• Making changes for Mehdi :) by @validbeck in #538
• Updated workflows/actions to dynamically generate an .env file by @validbeck in #552
• Quick workflow filter tweak by @validbeck in #554
• Updated "Assess compliance" for new evidence structure by @validbeck in #555
• Fixing on the fly notebook execution filter by @validbeck in #559
• 1 last attempt at the execution workflows by @validbeck in #561
• Update log-in-to-validmind.qmd by @mehdi0501 in #548
• Filtering for changes on prod/staging by @validbeck in #564
• Execution workflows are driving Beck insane by @validbeck in #569
• Removing the workflow filters for staging & prod by @validbeck in #572
• Huge product renaming release & cleanup by @validbeck in #562
• Docs — Customize inventory & findings lists by @validbeck in #581
• Docs — Adding custom dashboards & widgets by @validbeck in #583
• Workflow Python version fix by @validbeck in #586
• Fix link to SR 11-7 by @nrichers in #588
• Forgot the guides in the dropdown by @validbeck in #591

External

• Add developer fundamentals videos & training fixes by @nrichers in #543
• Add login button to docs site by @nrichers in #544
• Live notebook execution workflows, take ... whatever by @validbeck in #567
• Add support chatbot to docs site by @nrichers in #582
• Docs — Revamped FAQs by @validbeck in #558
• Updated Log In button to match main site + CSS updates to Training & Developer sections by @validbeck in #580

*frontend release not out yet.

New Contributors

• @johnwalz97 made their first contribution in #539
• @mehdi0501 made their first contribution in #548

Full Changelog: v2.5.25...v2.6.7

v2.5.25

What's Changed

This release includes many visual and authoring updates to the ValidMind documentation site, new guides on LLM features, an overhaul of our training portal, and finally pulls in the latest product renaming changes from the ValidMind Library.

• Docs audit p4 — About by @validbeck in #478
• Release notes to sprint 60 by @nrichers in #483
• Documentation for Workflows - Condition Branches by @validbeck in #484
• Instructions for upgrading ValidMind by @validbeck in #490
• Updated tachyons buttons & added video class by @validbeck in #486
• Rework training section & update validator training by @nrichers in #488
• Adjusting training styles by @validbeck in #497
• Documented ability to add attachment notes by @validbeck in #495
• Added Upgrade ValidMind instructions to Jupyter Notebooks by @validbeck in #500
• Training style overhaul + style/accuracy edit by @validbeck in #501
• Training course templates & organizational refinement by @validbeck in #509
• Documentation for filtering test result metadata by @validbeck in #505
• Document LLM features by @nrichers in #510
• Added a callout for workflow attachment options by @validbeck in #503
• Quick gallery css by @validbeck in #517
• Quick adjustment to hero BG img for training by @validbeck in #520
• Updated product terminology — documentation repo side by @validbeck in #521
• New sidebar & ToC theme by @validbeck in #524
• Updated validmind-library repo URL for documentation side by @validbeck in #529
• Quick CSS cleanup by @validbeck in #531

Full Changelog: v2.5.18...v2.5.25

v2.5.18

This release includes major documentation improvements, including a new front page for our documentation site, new feature documentation, and bug fixes.

What's Changed

• Documented ability to customize dashboard by @validbeck in #266
• Added ai_explain by @validbeck in #268
• Updated Jupyter Notebooks to match prod branch by @validbeck in #267
• Fix nlp and llm path in output by @nrichers in #269
• Added make install to the Makefile to install dependencies by @noosheenv in #271
• Release notes to sprint 55 by @noosheenv in #270
• Notebook to generate release notes by @noosheenv in #258
• Updated permissions in docs by @validbeck in #273
• Add monitoring section to user guides by @nrichers in #272
• Added some references for loading model predictions w/o available model by @validbeck in #276
• Renamed statuses to model lifecycle by @validbeck in #278
• Updated docs for validation guideline settings by @validbeck in #274
• Documentation for model interdependencies by @validbeck in #275
• Documented test result metadata in UI by @validbeck in #277
• Followup to PR#277 beck/sc-4768/documentation-display-result-metadata-on by @validbeck in #281
• Remove model documentation workflows by @validbeck in #282
• Unified threshold test/metrics > tests by @validbeck in #283
• Renamed custom fields to model inventory fields by @validbeck in #279
• Deploy PR previews to branch folders by @nrichers in #284
• Updated user management docs — Renaming roles by @validbeck in #285
• Add initial staging branch workflow by @nrichers in #300
• Remove rendered site output from repo by @nrichers in #308
• Add PR previews by @nrichers in #307
• Created branch for pulling from dev-framework by @validbeck in #317
• Add staging docs site deploy and update prod deploy by @nrichers in #309
• Revamped Model Activity docs by @validbeck in #315
• Release notes for Sept 9 2024 by @validbeck in #329
• Only running the PR previews bot when a PR is ready for review by @validbeck in #330
• Modify make python-docs to support rendering online by @nrichers in #336
• Investigate listing page issue by @nrichers in #334
• Fix Heap embeds for docs sites — main branch by @nrichers in #339
• Doc: Archive and delete inventory models by @validbeck in #351
• Revamped model findings docs for attachments by @validbeck in #352
• Pulling in latest changes from PR184 by @validbeck in #350
• Delete finding docs update by @validbeck in #355
• Moved activity to model inventory & adjusted pages by @validbeck in #358
• Training updates related to creating videos by @nrichers in #227
• Clarified style guidelines for links & training by @validbeck in #363
• Adding new ValidMind colors & logo by @nrichers in #366
• Update workflows to trigger on workflow_run by @nrichers in #368
• Update README.md by @nrichers in #369
• Use Quarto profiles for rendering the site on GitHub and locally by @nrichers in #372
• Docs site audit accuracy tone review — Guides p1 by @validbeck in #377
• Revamped View reports by @validbeck in #409
• Updated Work with content blocks by @validbeck in #390
• Make training slides more photogenic by @nrichers in #412
• Documented user registration process by @validbeck in #410
• Fix staging deploy in Makefile by @nrichers in #428
• Simplify merge strategy for staging by @nrichers in #373
• Testing simplified merge strategy by @validbeck in #431
• Fix branch in merge-main-into-staging.yaml by @nrichers in #432
• Styled screenshots & cleaned up current screenshots by @validbeck in #420
• Added currency field type to inventory field docs by @validbeck in #423
• Preview of Generate with AI docs sections by @validbeck in #419
• Added attachment field type by @validbeck in #442
• Pulling in latest from developer-framework PR#195 by @validbeck in #438
• Added new aliases to training.qmd by @validbeck in #444
• Docs: Work with metrics over time by @validbeck in #449
• Templates for videos by @nrichers in #415
• Calculation field instructions & example by @validbeck in #443
• Set up backfilled redirects for renamed pages by @validbeck in #454
• Embed Validating Models 101 playlist into Guides section by @nrichers in #446
• Embed "How do I ... add tests?" video in developer docs by @nrichers in #450
• Add link to GitHub for code samples by @nrichers in #460
• Implement new home page with updated search by @validbeck in #465
• Resolved janky footer styling by @validbeck in #468
• Remove references to projects in docs site by @validbeck in #467
• Nrichers/sc 6760/store python docs as zip file and extract by @nrichers in #461
• Applied small suggestions from product offsite by @validbeck in #474
• Deployment architecture docs by @nrichers in #459
• Docs audit p2 — Get Started by @validbeck in #469

Full Changelog: v2.4.10...v2.5.18

v2.4.10

What's Changed

• Documented new 2 step model registration by @validbeck in #253
• Add Private Service Connect & rework login info by @nrichers in #251
• Release notes to Sprint 53 by @nrichers in #257
• Removed icon from .qmd title and added it to navigation link by @validbeck in #260
• Single-sourcing documentation & examples created by @validbeck in #259
• Removed placeholder pages in guides by @validbeck in #262
• Edits to Approval step on Set up workflows by @validbeck in #264
• Fixed broken mp4 files in docs site by @validbeck in #265
• Updated variable naming conventions by @validbeck in #263
• Got rid of site unused by @validbeck in #261

Full Changelog: v2.4.4...v2.4.10

v2.4.4

What's Changed

• SR Validmind2 - First draft Validmind-226 Docs Update UM by @subatraSR2 in #167
• Fixing broken links in integrate_external_test_providers.ipynb by @noosheenv in #195
• Added "Documentation Overview" to Working with model documentation by @validbeck in #198
• New "Assign documentation section statuses" page in Guides by @validbeck in #197
• Added "Documentation section" info on Work with model findings by @validbeck in #196
• Release notes to Sprint 49 by @nrichers in #185
• Created "Manage model inventory custom fields" page in Guides by @validbeck in #199
• Validmind-226 SR 25May by @subatraSR2 in #201
• Cleaned up more docs site variables by @validbeck in #203
• Remedied loose docs pages by @validbeck in #202
• Documentation for inserting math formulas by @noosheenv in #204
• Adding model vendor support by @noosheenv in #205
• Quick fix for sc-3324 by @validbeck in #206
• Hide generate with AI button info by @nrichers in #207
• "Model Workflows" section in Guides by @validbeck in #209
• Created guide for organizing the model inventory by @noosheenv in #210
• Quick frontend release for editing of business unit names by @validbeck in #212
• ServiceRequest Update for manage-users file by @subatraSR2 in #213
• Update get-started.qmd to fix typo by @robinzimmermann in #211
• Resolved broken link out to external Contact/Demo WP page by @validbeck in #215
• Update quickstart-explore-sample-model-documentation.qmd by @robinzimmermann in #214
• Pulling PR#110 from developer-framework into documentation by @validbeck in #216
• Docs Site Audit - Scoping & Initial Styling by @validbeck in #217
• Create training collateral by @nrichers in #200
• Updated test-driven blocks by @noosheenv in #218
• Clarify what review means by @nrichers in #220
• Improve workflows prerequisite info by @nrichers in #221
• Updated docs for roles and permissions by @noosheenv in #219
• Docs site audit part 2 - inline link cleanup by @validbeck in #222
• Changed instances of Group Admin or Superuser to Customer Admin by @noosheenv in #224
• Reimplement docs site main page in css grid by @validbeck in #225
• Updated Customize Documentation Templates for Barclays by @validbeck in #228
• Updated Swap Documentation Templates for Barclays by @validbeck in #230
• Review and restructure articles for Onboarding section by @noosheenv in #226
• Updated test descriptions by @nrichers in #229
• Restructured docs site layout by @validbeck in #232
• Initial Matrix-style 404 page by @nrichers in #231
• PR#232 Additional fixes by @validbeck in #236
• Added Generate with AI (BETA) to Work with content blocks by @validbeck in #233
• Updated Edit model inventory fields by @validbeck in #234
• Updated CONFIGURATION section to capture settings options by @validbeck in #235
• Edited reference to documentation project by @validbeck in #238
• Added scroll-padding-top to offset anchors for fixed nav by @validbeck in #240
• Fixed broken external links out to restructured docs site by @validbeck in #239
• Add heap.io info to docs site headers by @nrichers in #241
• Fixing Makefile to not change nlp_and_llm to NLP_and_LLM by @noosheenv in #243
• Margin footnotes convention & cleanup by @validbeck in #244
• Action that runs quarto render to check for broken links and errors by @noosheenv in #237
• Fix issues introduced by checkout of _quarto.yml by @nrichers in #248
• Update overview-model-risk-management.qmd by @juanmleng in #246
• Fix minor typo in SR11-7 by @juanmleng in #247
• Established variable naming conventions by @validbeck in #245
• Update site banner by @nrichers in #249
• Fiddled with callout & link padding, edited README by @validbeck in #250
• Reimplemented CSS grid with Tachyons Flexbox instead by @validbeck in #252
• Fix notebook path by @nrichers in #254
• customizing_metrics_with_output_templates.ipynb > customizing_tests_with_output_templates.ipynb by @validbeck in #255

New Contributors

• @subatraSR2 made their first contribution in #167
• @juanmleng made their first contribution in #246

Full Changelog: v2.2.2...v2.4.4

v2.2.2

This release introduces an improved QuickStart experience, a new style guide for contributors, and improved docs site navigation with a new "About" section.

What's Changed

• ValidMind Style Guide by @validbeck in #174
• Update rendered site by @nrichers in #175
• First draft for sandbox instructions by @nrichers in #173
• Updated the About section to break down the articles into new categor… by @validbeck in #176
• Docs site update by @nrichers in #178
• Pulled in the latest version of the run dataset based tests notebook by @validbeck in #179
• Minor updates to sandbox instructions by @nrichers in #180
• Nrichers/sc 2887/release notes script updates by @nrichers in #177
• Quickstart docs site improvements by @nrichers in #182
• Created modular glossary & key concepts by @validbeck in #181
• Remove closed beta info by @nrichers in #184
• Add initial ChatGPT support to release notes script by @nrichers in #183
• Fix .gitgnore files and add .env example file by @nrichers in #186
• Add QuickStart video to the docs site by @nrichers in #187
• Move .env and .env.example into root of repo by @nrichers in #189
• Replace references to product names in documentation by @validbeck in #190
• Edit the sidebar to say ValidMind Community by @noosheenv in #193
• Fixing variable links leading to the ValidMind UI by @noosheenv in #194

New Contributors

• @noosheenv made their first contribution in #193

Full Changelog: v2.0.7...v2.2.2

v2.0.7

This release includes a reworked learning journey for our developer documentation and a new sandbox where you can explore tests available in the ValidMind Developer Framework.

What's Changed

• Sprint 46 release notes by @nrichers in #165
• Add test sandbox to docs site by @nrichers in #166
• Update swap-documentation-templates.qmd by @robinzimmermann in #170
• Fix typos in swap documentation templates doc by @nrichers in #171
• Revisit the "Developer Framework" getting started section (with bonus tests section rework) by @nrichers in #169
• Update _variables.yml by @validbeck in #172

New Contributors

• @validbeck made their first contribution in #172

Full Changelog: v2.0.0...v2.0.7