Quickstart — Model Validation

20 minutes

Use the ValidMind Library to run tests and validate a model, then attach your test results as evidence to your validation report in the ValidMind Platform.

Before you begin

• To try out ​ValidMind, you need to be a registered user on the ValidMind Platform.¹
• You’ll also want to make sure that you’re logged into the ValidMind Platform.²

¹ Register with ​ValidMind

²  Log in to ​ValidMind

Register a model for validation

Typically, you will be asked to validate a champion model that has already been independently registered in the model inventory and submitted to you.

For this quickstart, you’ll register a dummy model first and assign yourself as the validator to familiarize you with the ValidMind Platform interface:

1. In the left sidebar, click Inventory.

2. Click Register New Model.

3. To register a model for use with this quickstart, select:

   • what type of model is it? — New Model
   • template — Binary classification
   • use case — Attrition/Churn Management

4. Click Register Model to add the model to your inventory.

Registration modal with the options filled out for the model validation quickstart

Assign validator credentials

In order to log tests as a validator instead of as a developer, we’ll need to adjust your model stakeholder permissions.

On the model details page after you’ve registered your model:

Remove yourself as model owner

1. Click on the owners tile, then click on the x next to your name.
2. Click Save to apply your changes to that role.

Remove yourself as developer

1. Click on the developers tile, then click on the x next to your name.
2. Click Save to apply your changes to that role.

Add yourself as validator

1. Click on the validators tile, and select your name from the drop-down menu.
2. Click Save to apply your changes to that role.

Model stakeholders with only the validators assigned

Get your code snippet

Before we move on, let’s also retrieve the unique code snippet for your model that enables you to connect your testing environment with the correct model in the ValidMind Platform:

1. In the left sidebar that appears for your model, click Getting Started.

2. Locate the code snippet and click Copy snippet to clipboard.

Getting Started page with a sample code snippet

Using the ValidMind Library

Next, let’s set up the ValidMind Library in your validation environment of choice so we can use it to run and log tests, which helps automate the validation of your models.

Our companion notebook, Quickstart for model validation,³ walks you through the steps of installing the library in your environment, initializing the library for use, and running data quality and model evaluation tests that log results to the ValidMind Platform.

³ Quickstart for model validation

Access the quickstart notebook

You can either load the hosted version of our notebook, or download the notebook to run in your own local environment:

Open the hosted notebook (recommended)

1. Sign in to JupyterHub with your ​ValidMind login.

2. Open Quickstart for model validation and run the quickstart notebook.

Download the notebooks

Option 1: Clone the GitHub repository

1. Open a terminal or command prompt.

2. Navigate to the directory where you want to clone the repository.

3. Run the following command:

   git clone https://github.com/validmind/validmind-library.git

4. After the cloning process is complete, open notebooks/quickstart/quickstart_model_validation.ipynb in your validation environment and run the quickstart notebook..

Option 2: Download the code samples

1. Download our selection of code samples: notebooks.zip

2. Navigate to the location where you saved notebooks.zip and extract the contents.⁴

3. Navigate to the folder where you extracted the files.

4. Open notebooks/quickstart/quickstart_model_validation.ipynb in your validation environment and run the quickstart notebook.

⁴ Depending on your operating system, you can right-click on notebooks.zip and select Extract All … or Extract Here, for example.

Run the quickstart notebook

Do you have your code snippet?

To initialize the ValidMind Library which connects your environment to the correct model in the ValidMind Platform, you’ll need your unique code snippet!⁵

⁵ Get your code snippet

1. Follow the instructions to run the first two code cells in the notebook,⁶ which sets the stage by installing and initializing ​ValidMind.⁷

2. Under the cell at bottom of the Get your code snippet section, confirm that you see a success message verifying that you’ve connected to the right model.

   This message verifies that the library works as expected as is connected to the correct model and document type within the platform.

⁶ 
• Hover over each cell and click the icon; OR
• Press Shift + Enter on Windows or Cmd + Enter if you are on a Mac

⁷ Install and initialize the ValidMind Library

Example success message:

2025-06-11 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to ​ValidMind!
📊 Model: [ValidMind] Model validation quickstart (ID: cmbs6g0pi02li0g874mq9fek4)
📁 Document Type: model_validation

3. Continue running the rest of the notebook to automatically populate test results for your sample model to your validation report for that model in the platform.

Work with validation reports

After you successfully run the notebook, return to the ValidMind Platform:

1. In the left sidebar, click Inventory.

2. Locate or search for the model you registered for this quickstart and click on it to select it.⁸

3. In the left sidebar that appears for the model, click Validation Report:

   • Your model’s validation is broken down into sections, defined by your validation report templates.⁹
   • The report includes risk assessment summaries at the overall and per-section level, overviews of your compliance assessments provided within your validation report.¹⁰
   • Each sub-section allows you to attach test results as evidence,¹¹ as well as log findings based on your evaluation of datasets or models.¹²

⁸ Working with the model inventory

⁹ Working with templates

¹⁰ Assess compliance

¹¹ Assess compliance

¹² Add and manage model findings

Example validation report with outline

Validation report section with assessment summary and a sub-section

Add evidence to your report

Expand any section of the validation report to attach your test results and drafts of test result summaries generated by the ValidMind Library as evidence by clicking on Link Evidence to Report.

For example:

1. Locate the 2.2.1. Data Quality section and click on Class Imbalance Assessment.

2. Under the Class Imbalance Assessment sub-section, locate Validator Evidence then click Link Evidence to Report.

3. Select the Class Imbalance test results we logged: ValidMind Data Validation Class Imbalance

4. Click Update Linked Evidence to add the test results to the validation report.

Linking the Class Imbalance test results

Class Imbalance test results inserted as validator evidence

What’s next

Now that you’ve grasped the basics of using ​ValidMind for model validation, continue on your journey with our end-to-end training course for validators and browse through our resource hub for the ValidMind Library: