Skip to content

Commit regenerated Python API files and bump version#997

Merged
nrichers merged 1 commit intomainfrom
nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n
Oct 16, 2025
Merged

Commit regenerated Python API files and bump version#997
nrichers merged 1 commit intomainfrom
nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 16, 2025 •
edited
Loading

Pull Request Description

What and why?

This PR commits the latest Python API files and bumps the version to v2.10.0. There is no tag for this version yet, but it is the latest version on https://pypi.org/project/validmind/. The main improvement is that we point to the prod server which we should start externalizing.

Relates to:

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

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)

@nrichers nrichers added the internal Not to be externalized in the release notes label Oct 16, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 16, 2025

PR Summary

This PR is primarily focused on refactoring and improving the code documentation and type consistency across the project. Key changes include:

  • Enhanced Type Annotations: Many functions throughout the tests, model validation, statistics, and plots modules have been updated with explicit type hints using constructs such as Optional, Union, and List. This enhances code clarity and helps enforce correct usage of function inputs and outputs.

  • Improved Docstrings: Docstrings have been refined to provide clearer descriptions and better guidance for the functions. In some cases, additional sections like "Purpose", "Test Mechanism", "Signs of High Risk", "Strengths", and "Limitations" were added to give a comprehensive overview of what each testing function or visualization does.

  • Version Update: The version number has been updated in the relevant files (e.g., from 2.8.25 to 2.10.0) to reflect the most recent release, helping maintain version consistency across the documentation and release notes.

Overall, these changes are syntactic and documentary in nature. They are intended to improve maintainability, readability, and usability of the codebase without altering the underlying functionality.

Test Suggestions

  • Run the full automated test suite to ensure that no functionality is broken due to the updated type hints and refactorings.
  • Verify that interactive plots (e.g., BoxPlot, HistogramPlot, ViolinPlot, and CorrelationHeatmap) continue to render correctly and interactivity (hover, zoom, etc.) works as expected.
  • Perform integration tests with downstream modules or API consumers to ensure the new type annotations do not introduce compatibility issues.
  • Check that the version update (v2.10.0) is consistently reflected in all parts of the application and documentation.

@nrichers nrichers mentioned this pull request Oct 16, 2025
Merged
11 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Oct 16, 2025

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions
Copy link
Contributor

github-actions bot commented Oct 16, 2025

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: dad7f96

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.60 1.00 0.90
/get-started/get-started.html 0.85 0.67 1.00 0.80
/guide/guides.html 0.85 0.68 1.00 0.90
/index.html 0.93 0.66 1.00 0.90
/releases/all-releases.html 0.86 0.67 1.00 0.80
/support/support.html 0.91 0.68 1.00 0.90
/training/training.html 0.82 0.69 0.96 0.80

@nrichers nrichers requested a review from validbeck October 16, 2025 19:26
validbeck
validbeck approved these changes Oct 16, 2025
View reviewed changes
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

🌮

@nrichers nrichers merged commit 0acec56 into main Oct 16, 2025
16 checks passed
@nrichers nrichers deleted the nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n branch October 16, 2025 21:55
nrichers added a commit that referenced this pull request Oct 16, 2025
@nrichers
Commit regenerated Python API files and bump version (#997)
5fb752c
nrichers added a commit that referenced this pull request Oct 17, 2025
@nrichers
Commit regenerated Python API files and bump version (#997) (#1000)
ad883f9
nrichers added a commit that referenced this pull request Oct 31, 2025
@nrichers @validbeck @github-actions
Fix merge conflicts for October 30 (#1017)
7f28231 
* Removing validmind version variable (#921)

* infra: Merge main into staging PRs created by staging deploy now indicate original PR# (#924)

* Updating main into staging workflow

* Testing branch versions

* Removing test file

* Fix Makefile help

* infra: Delete older PR preview comments from validate & execute flows (#932)

* Adding deletion of old preview comments back in

* Removing unused variable

* Adding same thing to notebooks

* Edit to notebook, should remove old comment

* hm

* Deleting test execution notebook

* ValidMind Platform releases: Exclude `admin-ui` from roundup listing page (#933)

* Exclude admin-ui from platform releases roundup

* Adjust

* Remove old variable usage

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* docs: Export findings (#939)

* Setup: Customize model findings layout

* Save point

* Save point

* Draft: Customize model finding layouts

* Setup: Export findings

* Draft: Export findings

* Export documentation > Export documents

* Editing

* Cleanup

* Proofread

* Filter

* Update API reference to use prod server (#938)

* Update API reference to use prod server

* Update Makefile for admin API as well

* docs: Export inventory (#943)

* Setup: Export inventory

* Draft: Export inventory

* Proofreading

* Oops

* docs: Updated Export findings (#944)

* Setup

* Proofread

* Testing pinned Quarto version

* docs: Customize Virtual Document Validator (#947)

* Set up: Manage regulations and policies

* WIP

* Customize VDV draft

* Edits: Check documentation for compliance

* Proofread

* Quick UI updates

* Pin a Quarto version specified in Action variables for our deployment workflows (#951)

* Testing pinned Quarto version

* Applying pinned Quarto version to other workflows

* Removing test notebook

* docs: Workflow Wait step time delta configuration (#954)

* Setup: Wait step time delta

* Editing

* Updating example screencap for Wait

* Remove login button and make related CSS modular (#949)

* Remove login button and make related CSS modular

* Make login link specific to profile

* Change scss/ to assets/style/ and update README.md

* Fix double space

* Check out .gitignore from main

* Minor README.md tweak

* One more minor README.md tweak

* Add missing backticks

* Fix Log In button for developer.css

* Minor edits

* Slight adjust to CSS in-progress message

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* docs: Updated "Manage model finding fields" (#958)

* Edit: DElete model findings

* Edit: Manage model finding fields

* Editing UI wording

* Editing...

* Editing......

* Proofreading

* Edit

* docs: Updated "Manage document templates" (#960)

* Draft: Delete document templates

* Edit: View document templates

* Wrapping up

* Stupid broken link

* Edit: VDV Findings > Observations (#962)

* docs: Update inventory & finding field views (#964)

* Edit: Manage model inventory fields

* Save point

* Edit: Manage model finding fields

* Cleanup

* Proofread

* Adjustments

* Final touch

* Fix bug in Makefile (#935)

* Bug bash: nrichers/sc 12201/disable algolia search on api reference pages (#968)

* Disable Algolia search on Public API reference page

* Fix stray comment indent

* docs: Add shared text blocks to YAML templates (#970)

* Setup: Add library blocks to YAML templates

* Save point

* Save point

* Tidying up

* docs & training: Virtual Document Validator, regulations & policies set up update (#973)

* Draft: Questions from PDF uploads

* Training: Setup for regulations & policies

* Save point

* Save point

* Draft: Administrator Fundamentals update

* Draft: Developer Fundamentals update

* Proofreading

* Hiding PDF upload for VDV (#975)

* Add system access requirements (#977)

* Add initial system access requirements topic

* Text edits

* More edits

* Fix incomplete sentence

* Basic version: Improve navigation for Python API and Public REST API (#966)

* Apply the basic fixes we agreed on

* Remove a:hover experiment

* Update .gitignore

* Underline specific links only

* Address review comments from Beck

* Final CSS tweak

* Update release_notes_check.py (#981)

* Enable release notes checks to post comment with instructions (#984)

* Update release_notes_check.yaml

* Update release_notes_check.py

* Edit: Remove info for add finding via doc section (#978)

* docs: Updated Workflows Approval Step info (#979)

* Edit: Approval step & condition instructions

* Update: Approval Step example

* Add Tidy Layout callout

* Bump versions to 25.10 & v2.9.5 + public release landing page improvements (#971)

* Bump release versions

* Add temporary branch ref

* Fix Makefile help

* Reorder all releases page, bump up length of descriptions shown

* Turn older releases into collapsible section

* Fix YAML

* Fix YAML again

* Add pagination style from release notes portal

* Add button for all feature highlights & add whitespace

* Wording tweak

* Run make get-source

* All releases page tweaks

* Fix broken links

* Change heading to Latest features for consistency

* Address Beck's sidebar suggestion

* Fix date in this repo, too

* Add whitespace before heading

* Remove the branch ref I had THREE reminders for to remove ... (#991)

* docs & training: Calculation Finding Fields (#988)

* Draft: Calculation Finding Fields

* Draft: Calculation Finding Fields in training

* Save point

* Cleaning up

* Proofreading

* Save point

* Update site/guide/model-inventory/_field-types.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update _field-types.qmd

* Applying Andres's code edit

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Upgrade Tachyons with official codeblock fix & remove our workaround (#995)

* Commit regenerated Python API files and bump version (#997)

* docs: Workflows for findings (#998)

* Setup: Workflows for findings

* Renaming Setting up model workflows page

* Fixing links

* Sidebar link

* Renaming directory

* Fixing broken links pt2

* Cleaning up...

* More cleanup

* More

* More renaming

* Oops

* Almost there

* Stragglers

* One more?

* & includes

* Save point

* Edit: Add new workflows in docs

* Edit: Edit existing workflows in docs

* Edit: Review active workflows in docs

* Edit: Review workflow histories in docs

* Save point

* Edit: Initiate workflows in docs

* Edit: Abort workflows in docs

* Edit: Manage workflow tasks

* Edit: Transition workflows

* More cleaup

* Training: Edit Add new workflows

* Training: Review active workflows

* Training: Review workflow history

* Training: Initiate workflows

* Training: Reset workflows

* Training: Abort workflows

* Training: Transition workflows

* Proofreading

* More proofreading

* ooo figured out a neat conditional hack

* Editing training slides

* Updating single-source templates

* docs & training: Updates to model registration UX (#1003)

* Edit: Register models in inventory

* Quickstart: Register model developer

* Quickstart: Register model validator

* Updating code snippet images

* Updating developer model details image

* Updating validation report details image

* Admin training: Register demo model

* Developer training: Register demo model

* Validator training: Register demo model

* Cleanup

* Proofreading

* Edit: Manage model stakeholder types on registration

* Edit: Manage model stakeholder types on registration training pt1

* Edit: Manage model stakeholder types on registration training pt2

* Edit

* Edit

* Pulling in latest notebooks from sibling PR

* Nrichers/sc 12743/fix quarto docs workflow issue (#1001)

* Remove validmind/ folder and old python-docs.zip file

* Change make python-docs to generate the Python API files

* Add site/validmind to the .gitignore

* Add make python-docs equivalent to workflows

* Try RELEASE_NOTES_RO_PAT

* docs: Workflows User Action v2 step deadlines (#1005)

* Setup: Edits to User Action v2 deadlines

* Save point

* Save point

* Updated example images

* Proofread

* Formatting

* Explicitly install poetry before generating Python API docs

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Setup: Trigger workflow start on date & datetime (#1008)

* Remove Slack sign-up page & update community resources (#1010)

* Remove Slack sign-up page & update community resources

* Minor consistency edit

* Remove sign-up hint I added

* docs: Manage finding severities (#1013)

* Setup: Manage finding severities

* Docs: Manage finding severities

* Training: Manage finding severities

* Cleaning up community page

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@validbeck validbeck validbeck approved these changes

Assignees

No one assigned

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nrichers @validbeck