Added new introductory validation notebooks

[validbeck]

Internal Notes for Reviewers

sc-9191

LIVE PREVIEW

ValidMind for model validation notebooks

These were added to the "developer" (now library) portal:

Sidenav	Listing tiles

ValidMind for model development notebooks

These have the updated numbering structure:

Sidenav	Listing tiles

Developers > ValidMind Library

• Since this portal is much more than a developer portal, I've made the language and links surrounding the portal more universal:

Main drop-down	Collapsed drop-down

• You may notice that I also applied the styling that the API docs have to this and the notebooks/test descriptions, since it's jarring for the two sections to have different side navigations (BONUS: This also takes care of the really squished long-titles we have for notebooks!):

• I also moved the sidebar for this landing section to its own _sidebar.yaml:

documentation/site/developer/_sidebar.yaml

Line 3 in a89901c

- id: validmind-library

documentation/site/_quarto.yml

Line 5 in a89901c

- developer/_sidebar.yaml

ValidMind Library API

There is a sibling PR to this to change the reference to include the API in the title/link for that landing page as this was somehow missed in the initial one — again, trying to reduce confusion with our habit of naming pages/sections the same darn thing!

validmind/validmind-library#350

Introduction for model developers

This old notebook and its executed version I reverted to main (documentation side only) as we haven't yet updated our training to be able to get rid of the notebook — working on it.

validmind.com

I removed this link from the main top navigation as it doesn't need to feature so heavily when it's also in the footer, based on discussions we had during the homepage redesign.

Main nav	Collapsed nav

[github-actions]

A PR preview is available: Preview URL

[validbeck]

Changed references to the API to "ValidMind Library Python API" here as well, and updated the variable to match:

documentation/site/_variables.yml

Line 22 in db08c00

api: "ValidMind Library Python API"

EDIT: Actually, we probably want to keep mini drop-down with "Python Library," right? hmm....

[github-actions]

PR Summary

This pull request introduces several enhancements and bug fixes to the ValidMind documentation and testing framework. The key changes include:

1. Documentation Updates:

   • Updated various documentation files to improve clarity and consistency, particularly in the ValidMind Library and its usage.
   • Added new sections and examples to the documentation, including detailed guides on setting up and using the ValidMind Library for model validation and development.
   • Enhanced the documentation for custom tests and external test providers, providing clearer instructions and examples.

2. Testing Enhancements:

   • Introduced new tests and updated existing ones to cover more scenarios, particularly in the areas of model validation and data quality.
   • Improved the test descriptions and added more detailed explanations for test parameters and expected outcomes.
   • Added new test files and updated existing ones to ensure comprehensive coverage of the ValidMind functionalities.

3. Code Improvements:

   • Refactored code to improve readability and maintainability, including better organization of test files and documentation.
   • Fixed minor bugs and inconsistencies in the codebase, particularly in the test execution and logging mechanisms.

4. Security and Compliance:

   • Updated security-related documentation to ensure compliance with best practices and standards.
   • Improved the handling of sensitive data in test results and logging, ensuring that sensitive information is not exposed inadvertently.

Overall, these changes aim to enhance the usability, clarity, and security of the ValidMind framework, making it easier for users to implement and document their models effectively.

Test Suggestions

• Run all updated and new tests to ensure they pass successfully.
• Verify that the documentation changes are correctly reflected in the rendered output.
• Check the integration of new test files with the existing test suite.
• Ensure that the new documentation examples work as expected when followed step-by-step.
• Test the logging and handling of sensitive data to ensure compliance with security standards.

[github-actions]

A PR preview is available: Preview URL

[github-actions]

A PR preview is available: Preview URL

[github-actions]

A PR preview is available: Preview URL

[nrichers]

LGTM! Great PR. 🥳

You may notice that I also applied the styling that the API docs have ... (BONUS: This also takes care of the really squished long-titles we have for notebooks!)

I quite appreciate this change and I agree that the styling is preferable, so thank you. 💖

We also have an issue with long sidebar entries in the rest of the docs site that frequently cause wrapping. I would be amenable to applying the same styling from the API reference elsewhere, so it is consistent throughout the site. (Not in this PR, but as a future improvement.)

[nrichers]

@validbeck a similar story here — while debugging my new script to generate release notes, I was trying to figure out why it was skipping docs updates. Not only are these changes not internal, they are should likely also be labelled with highlight.

[validbeck]

cc: @nrichers

These should be surfaced in the release notes alongside the actual release for the notebooks. Please refer to the external release notes on the notebook PR here:

validmind/validmind-library#348