Skip to content

Edit how_to notebooks: Explore tests #391

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

LoiAnsah
Copy link
Contributor

@LoiAnsah LoiAnsah commented Jul 11, 2025

Pull Request Description

What and why?

How to test

  • Pull down this PR: gh pr checkout 391
  • Open notebooks/how_to/explore_test_suites.ipynb to review and run.

What needs special review?

Ensure that my changes are corrected.

@LoiAnsah LoiAnsah self-assigned this Jul 11, 2025
@validbeck
Copy link
Collaborator

Why is this PR up when you haven't merged the other notebook PR? ;)

@LoiAnsah
Copy link
Contributor Author

@validbeck, I created it last week so I could get a head start on the work.

Copy link
Contributor

PR Summary

The PR significantly updates the 'Explore tests' notebook to provide a more comprehensive and structured introduction to the ValidMind Library. The revised notebook now includes detailed sections explaining the purpose of the tests module, introducing key concepts around model documentation, and guiding new users through the initial setup and usage of the library. Notable additions include:

  • An expanded introduction explaining ValidMind’s role in managing model risk and automating model documentation.
  • Sections such as 'About ValidMind', 'Before you begin', 'New to ValidMind?', and 'Key Concepts' which break down the functions and utility of the library.
  • Clear instructions and recommendations for installing the library using a pip command, as well as guidance on handling potential module installation issues.
  • Updated description for importing utilities (describe_test, list_tests, etc.) that help users filter and view test details.

These changes enhance the instructional quality of the notebook and aim to improve the user experience by providing more context and detailed guidance on how to effectively use the ValidMind Library.

Test Suggestions

  • Run the notebook in an interactive environment to verify that all markdown cells render correctly and are well-formatted.
  • Test the pip installation command to ensure that the ValidMind Library is installed without errors.
  • Validate that hyperlinks and alert blocks display as intended and navigate correctly.
  • Execute code cells sequentially to ensure that the import statements and any subsequent commands work as expected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants