Skip to content

Rename and restructure Supported Models page#1163

Open
nrichers wants to merge 28 commits intomainfrom
sc-5014/supported-model-frameworks
Open

Rename and restructure Supported Models page#1163
nrichers wants to merge 28 commits intomainfrom
sc-5014/supported-model-frameworks

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Feb 10, 2026

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 wrappersFunctionModel, 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
Capto_ 2026-03-04_05-34-58_pm Capto_ 2026-03-06_08-33-47_am

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

@nrichers nrichers added the documentation Improvements or additions to documentation label Feb 10, 2026
@nrichers nrichers force-pushed the sc-5014/supported-model-frameworks branch from 35cd69b to 8478562 Compare February 10, 2026 05:24
@claude
Copy link

claude bot commented Feb 10, 2026

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:


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
@nrichers nrichers force-pushed the sc-5014/supported-model-frameworks branch from 8478562 to 2db869e Compare February 10, 2026 05:25
@nrichers nrichers added the internal Not to be externalized in the release notes label Feb 10, 2026
@nrichers nrichers force-pushed the sc-5014/supported-model-frameworks branch from e530f29 to 2e343df Compare March 5, 2026 22:41
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

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

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

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
nrichers and others added 9 commits March 12, 2026 15:36
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@github-actions
Copy link
Contributor

PR Summary

This pull request consolidates and updates the documentation for supported models by replacing references to the old "Supported models" file with a new "Supported models and frameworks" page. The following key changes were made:

  • Updated multiple documentation files (e.g., site/about/overview-model-documentation.qmd, site/developer/_sidebar.yaml, site/faq/faq-integrations.qmd, and the release highlight in site/releases/2024/2024-mar-27/highlights.qmd) to link to the new page.
  • Added a new file: site/developer/supported-models-and-frameworks.qmd. This file not only carries forward the content from the old "Supported models" page but also extends it with detailed sections on various model types, testing suites, and supported frameworks such as Hugging Face, PyTorch, and others.
  • Removed the old file site/developer/supported-models.qmd, ensuring that all references now point to the updated and more comprehensive documentation.

The functional change in this PR is primarily centered around improving the navigation and clarity of the documentation, making it easier for developers to find detailed guides and testing instructions for different model frameworks.

Test Suggestions

  • Verify that all updated links (e.g., in the sidebar, FAQ, and release notes) correctly navigate to the new supported models and frameworks page.
  • Check that the new file (supported-models-and-frameworks.qmd) renders correctly and displays all expected sections and panels.
  • Ensure that removing the old supported-models.qmd file did not break any internal references or cause 404 errors.
  • Perform a site-wide search to verify that no outdated links remain pointing to the removed file.

@nrichers nrichers requested a review from validbeck March 13, 2026 00:06
@github-actions
Copy link
Contributor

Validate docs site

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants