Rename and restructure Supported Models page#1163
Conversation
35cd69b to
8478562
Compare
Code ReviewFound 1 issue that needs to be addressed: Issue: Broken sidebar navigation linkFile: Problem: The sidebar file still references 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.qmdShould be: - developer/supported-model-frameworks.qmdReferences:
Note: All other internal references (in |
- 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
8478562 to
2db869e
Compare
e530f29 to
2e343df
Compare
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: 3944207 Modify the workflow to check a different depth:
|
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>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
PR SummaryThis 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:
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
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Pull Request Description
What and why?
Renames "Supported models" to "Supported models and frameworks" and restructures content:
FunctionModel,PipelineModel,MetadataModelAdds 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
How to test
Check the live preview: Supported models and frameworks
What needs special review?
Dependencies, breaking changes, and deployment notes
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