-
Notifications
You must be signed in to change notification settings - Fork 4
quickstart: Model Development #748
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
quickstart: Model Development #748
Conversation
PR SummaryThis pull request introduces several enhancements to the documentation and workflow for model development using the ValidMind platform. Key changes include:
These changes aim to improve the onboarding experience for new users and provide a more cohesive and comprehensive guide to using the ValidMind platform for model development. Test Suggestions
|
PR SummaryThis pull request introduces several enhancements to the documentation and workflow for model development using the ValidMind platform. Key changes include:
These changes aim to provide a more cohesive and user-friendly experience for new users getting started with model development on the ValidMind platform. Test Suggestions
|
PR SummaryThis pull request introduces several enhancements to the documentation and workflow for model development using the ValidMind platform. Key changes include:
These changes aim to provide a more cohesive and user-friendly experience for new users getting started with model development on the ValidMind platform. Test Suggestions
|
Vale source linterShow first 30 files with issuessite/404.qmd
site/about/contributing/style-guide/conventions.qmd
site/about/contributing/style-guide/style-guide.qmd
site/about/contributing/style-guide/voice-and-tone.qmd
site/about/contributing/validmind-community.qmd
site/about/deployment/_deployment-available-options.qmd
site/about/deployment/deployment-options.qmd
site/about/deployment/multi-tenant-cloud.qmd
site/about/deployment/virtual-private-validmind.qmd
site/about/fine-print/data-privacy-policy.qmd
site/about/fine-print/license-agreement.qmd
site/about/glossary/_ai.qmd
site/about/glossary/_attestation.qmd
site/about/glossary/_developer-tools.qmd
site/about/glossary/_model-documentation.qmd
site/about/glossary/_models.qmd
site/about/glossary/_monitoring.qmd
site/about/glossary/_mrm.qmd
site/about/glossary/_validation-reports.qmd
site/about/glossary/_validmind-features.qmd
site/about/glossary/_validmind.qmd
site/about/glossary/glossary.qmd
site/about/glossary/key_concepts/_docs.qmd
site/about/glossary/key_concepts/_inputs.qmd
site/about/glossary/key_concepts/_key-concepts.qmd
site/about/glossary/key_concepts/_metrics.qmd
site/about/glossary/key_concepts/_monitoring-template.qmd
site/about/glossary/key_concepts/_outputs.qmd
site/about/glossary/key_concepts/_parameters.qmd
site/about/glossary/key_concepts/_template.qmd
... and 574 more files with issues |
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: d5a4de6 Modify the workflow to check a different depth:
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have reviewed the new generated model development and ran the Notebook (locally). Everything works!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR, mainly just some stylistic comments — will approve after these are addressed. 🚀 It's GREAT to see us remove some of the last vestiges of our early smoke-and-mirrors docs site. 🙌
Internal Notes for Reviewers
Quickstart — Model Development
LIVE PREVIEW
Brand new introductory guide for model development/documentation, with cleaned up and refined information for a hopefully less confusing experience.
get-started/common-assets
folder for the steps I know will be repeated in the validation quickstart.installation
branch: Had to push a quick commit to adjust the link here as the original file was replaced by this PR. cc: @nrichersHow to test
You can pull this PR down and preview locally, or just click the live preview link above. ;)
Recommended review:
External Release Notes
We've completely renovated our quickstart experience for model developers, aiming to present a more user-friendly introduction to using ValidMind for documenting models. This quickstart covers the basics of using ValidMind to develop models, walking you through how to register your first model, use the ValidMind Library to run tests and document a model, then review your generated model documentation using the ValidMind Platform.
This quickstart is the first in a series of new user journeys — look forward to our upcoming introductory guides for model validation and platform administration!