How to use ValidMind Library features

Published

February 13, 2026

Browse our range of Jupyter Notebooks demonstrating how to use the core features of the ValidMind Library. Use these how-to notebooks to get familiar with the library's capabilities and apply them to your own use cases.

How-to by topic

Customize test result descriptions
15 min
When you run ValidMind tests, test descriptions are automatically generated with LLM using the test results, the test name, and the static test definitions provided in the test's docstring. While this metadata offers valuable high-level overviews of tests, insights produced by the LLM-based descriptions may not always align with your specific use…
Dataset Column Filters when Running Tests
1 min
To run a test on a dataset but only include certain columns from that dataset, you can use the new columns option. This is done by passing a dictionary for the dataset input for the test instead of the dataset object or dataset input ID directly. This dictionary should have the following keys:
Document multiple results for the same test
11 min
Documentation templates facilitate the presentation of multiple unique test results for a single test.
Enable PII detection in tests
9 min
Learn how to enable and configure Personally Identifiable Information (PII) detection when running tests with the ValidMind Library. Choose whether or not to include PII in test descriptions generated, or whether or not to include PII in test results logged to the ValidMind Platform.
Explore test suites
6 min
Explore ValidMind test suites, pre-built collections of related tests used to evaluate specific aspects of your model. Retrieve available test suites and details for tests within a suite to understand their functionality, allowing you to select the appropriate test suites for your use cases.
Explore tests
7 min
Explore the individual out-the-box tests available in the ValidMind Library, and identify which tests to run to evaluate different aspects of your model. Browse available tests, view their descriptions, and filter by tags or task type to find tests relevant to your use case.
Implement custom tests
16 min
Custom tests extend the functionality of ValidMind, allowing you to document any model or use case with added flexibility.
Integrate external test providers
15 min
Register a custom test provider with the ValidMind Library to run your own tests.
Run comparison tests
13 min
Use the ValidMind Library's run_test function to run built-in or custom tests that take any combination of datasets or models as inputs. Comparison tests allow you to run existing test over different groups of inputs and produces a single consolidated list of outputs in the form of text, tables, and images that get populated in model documentation.
Run dataset based tests
11 min
Use the ValidMind Library's run_test function to run built-in or custom tests that take any dataset or model as input. These tests generate outputs in the form of text, tables, and images that get populated in model documentation.
Run documentation tests with custom configurations
11 min
When running documentation tests, you can configure inputs and parameters for individual tests by passing a config as a parameter.
Run individual documentation sections
9 min
For targeted testing, you can run tests on individual sections or specific groups of sections in your model documentation.
Run tests with multiple datasets
10 min
To support running tests that require more than one dataset, ValidMind provides a mechanim that allows you to pass multiple datasets as inputs.
Understand and utilize RawData in ValidMind tests
6 min
Test functions in ValidMind can return a special object called RawData, which holds intermediate or unprocessed data produced somewhere in the test logic but not returned as part of the test's visible output, such as in tables or figures.
No matching items