Rename and restructure Supported Models page by nrichers · Pull Request #1163 · validmind/documentation

nrichers · 2026-02-10T05:20:35Z

Pull Request Description

What and why?

Renames "Supported models" to "Supported models and frameworks" and restructures content:

What is supported? — Framework-agnostic approach with dedicated wrappers
AI systems — LLM classifiers, NLP classifiers, Summarization, Embeddings, RAG with specific test suites
Machine learning models — Hugging Face, PyTorch, tree-based, KNN, clustering
Traditional statistical models — Linear/logistic regression, time series
Framework support — Wrappers with install commands (CatBoost, Hugging Face, PyTorch, R models via rpy2, scikit-learn, statsmodels, XGBoost)
Custom model wrappers — FunctionModel, PipelineModel, MetadataModel
GenAI/LLM and RAG evaluation support — FoundationModel, RAGAS integration
Python and dependency compatibility — Optional extras table

Adds aliases to preserve existing links to supported-models.html.

Addresses sc-5014.

What are these changes based on?

I inspected the ValidMind library source code to see which frameworks it supports, what each one needs to work with our tests, and how GenAI/RAG evaluation fits in. The updated page should reflect what the product actually does, based on the code. I then iterated over the page several times, adding or removing content that seemed relevant to users getting to know our library for the first time but without relying on knowledge of our codebase.

Open questions

To keep the length of the topic reasonable, I used tabbed panels wherever possible but I'm still not sure if this topic might not be better off broken up into several smaller topics under a common heading? Feedback would be most welcome.
It's been a balancing act between too little information and then too much. At this point, I think we're not missing content (unless you have some additional suggestions), but is there content we could omit to shorten the page?

How to test

Check the live preview: Supported models and frameworks

Before	After

What needs special review?

Accuracy of framework wrappers and install commands
Mermaid diagram rendering for test input flow

Dependencies, breaking changes, and deployment notes

Aliases ensure no breaking change for existing links

Release notes

Restructured the "Supported Models" documentation page as "Supported Model Frameworks" with clearer guidance on test requirements, framework wrappers, and GenAI/RAG support. Learn more

Checklist

What and why
How to test
PR linked to Shortcut
Tested locally

claude · 2026-02-10T05:24:37Z

Code Review

Found 1 issue that needs to be addressed:

Issue: Broken sidebar navigation link

File: site/developer/_sidebar.yaml at line 13

Problem: The sidebar file still references developer/supported-models.qmd, which is deleted by this PR. The reference needs to be updated to developer/supported-model-frameworks.qmd to match the new filename.

Impact: Without this change, the Quarto build will fail or produce a broken navigation entry in the sidebar.

Current code (line 13):

        - developer/supported-models.qmd

Should be:

        - developer/supported-model-frameworks.qmd

References:

Deleted file: https://github.com/validmind/documentation/blob/35cd69b1945840b9a78d239310dd306642cffa5d/site/developer/supported-models.qmd
New file: https://github.com/validmind/documentation/blob/35cd69b1945840b9a78d239310dd306642cffa5d/site/developer/supported-model-frameworks.qmd

Sidebar file:

documentation/site/developer/_sidebar.yaml

Lines 12 to 14 in 35cd69b

    
             file: developer/validmind-library.qmd 
        
           - developer/supported-models.qmd 
        
           - text: "---"

Note: All other internal references (in overview-model-documentation.qmd and faq-integrations.qmd) were correctly updated. The aliases in the new file properly preserve old URL paths for backwards compatibility.

- Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd

…supported-model-frameworks

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

nrichers · 2026-03-17T19:16:34Z

@juanmleng @validbeck thank you both for your review! I addressed all of your comments, could one of you approve this PR, please?

nrichers · 2026-03-17T21:28:12Z

@validbeck as discussed I removed the links I'd added.

8e53196

github-actions · 2026-03-17T21:31:39Z

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: faa9f6f

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.69	1.00	0.82
/get-started/get-started.html	0.85	0.71	1.00	0.73
/guide/guides.html	0.85	0.69	1.00	0.82
/index.html	0.93	0.63	1.00	0.82
/releases/all-releases.html	0.86	0.69	1.00	0.73
/support/support.html	0.91	0.68	1.00	0.82
/training/training.html	0.85	0.63	0.96	0.73

github-actions · 2026-03-17T21:37:25Z

PR Summary

This PR updates several documentation files to replace the old 'Supported models' page with a newly introduced 'Supported models and frameworks' document. Key changes include:

Modifying internal links across documentation files (overview-model-documentation.qmd, _sidebar.yaml, faq-integrations.qmd, and release highlights) to point to the new file at /developer/supported-models-and-frameworks.qmd instead of the deprecated /developer/supported-models.qmd.
Adding a comprehensive new documentation file (supported-models-and-frameworks.qmd) that not only covers supported models but also elaborates on frameworks, including detailed sections about AI systems, machine learning models, traditional statistical models, and custom wrappers. Additionally, it provides guidance on API usage, test input requirements, and integration setups for LLMs and GenAI.
Removing the old supported-models.qmd file from the repository as it has been fully replaced by the new file.

The functional impact is solely on documentation updates, ensuring that users receive updated, structured, and expanded guidance on supported models and frameworks for the ValidMind library.

Test Suggestions

Verify that all internal links (in _sidebar.yaml, FAQ, and release highlights) now point to the new 'Supported models and frameworks' file and that they load correctly.
Check the navigation and search in the documentation site to ensure that the new file is indexed and accessible.
Manually review the new 'Supported models and frameworks' file for formatting issues and broken links.
Ensure the removal of the old 'Supported models' file does not leave any dead links or references elsewhere in the documentation.

github-actions · 2026-03-17T21:49:29Z

Validate docs site

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

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Fixing numbering * Fixing indenting --------- Co-authored-by: Nik Richers <nik@validmind.ai> * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Whitespace * Address review comment from Juan * Remove links I'd added --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- 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> Co-authored-by: Spencer Krum <nibz@validmind.ai>

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd * Fixing numbering * Fixing indenting --------- * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd * Whitespace * Address review comment from Juan * Remove links I'd added --------- * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- 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> Co-authored-by: Spencer Krum <nibz@validmind.ai>

nrichers added the documentation Improvements or additions to documentation label Feb 10, 2026

nrichers force-pushed the sc-5014/supported-model-frameworks branch from 35cd69b to 8478562 Compare February 10, 2026 05:24

nrichers force-pushed the sc-5014/supported-model-frameworks branch from 8478562 to 2db869e Compare February 10, 2026 05:25

nrichers added the internal Not to be externalized in the release notes label Feb 10, 2026

nrichers added 5 commits February 10, 2026 12:38

Fix missed sidebar update

83e0083

Fix broken link

bba9d36

Merge branch 'main' of github.com:validmind/documentation into sc-5014/…

2dba418

…supported-model-frameworks

Add bridging sentence after callout

11a49cb

Re-add a what does supported mean heading

2e343df

nrichers force-pushed the sc-5014/supported-model-frameworks branch from e530f29 to 2e343df Compare March 5, 2026 22:41

nrichers added 12 commits March 5, 2026 15:33

Minor edit

0297002

Re-add some old goodness

33466af

Much better detail

04c8886

Edits

0f0e65a

More edits

c695ba7

Edits

16f3f6f

Remove old supported models page

eaef82b

Minor edit

e7ac6eb

Edits

6be94b7

File rename again

5c1b48b

Remove duplicated embeddings content

0a741dd

Uncomment and move info about tests for text-generating models

73e2595

nrichers requested review from cachafla, juanmleng and validbeck March 6, 2026 16:54

validbeck requested changes Mar 6, 2026

View reviewed changes

nrichers and others added 2 commits March 12, 2026 15:36

Update site/developer/supported-models-and-frameworks.qmd

791915f

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

Update site/developer/supported-models-and-frameworks.qmd

3c26a38

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

nrichers and others added 8 commits March 12, 2026 15:37

Update site/developer/supported-models-and-frameworks.qmd

585dce3

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

Update site/developer/supported-models-and-frameworks.qmd

0bfd4f2

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

Update site/developer/supported-models-and-frameworks.qmd

8530a27

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

Switch to definition list after removing lead-in text for bulleted list

d03b58a

Two columns for a neater layout

0fc9c62

Remove pointless link

72c74e2

Add links, text edits

e7e98b4

Update site/developer/supported-models-and-frameworks.qmd

8ff7c5e

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

nrichers requested a review from validbeck March 13, 2026 00:06

Whitespace

0c43316