Quickstart — Model Development

15 minutes

Register your first model, use the ValidMind Library to run tests and document a model, then review your generated model documentation within 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 your first model

The first step to using ​ValidMind to develop models is to register them in your model inventory:

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 development quickstart

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 development environment of choice so we can use it to run and log tests, which helps automate the documentation of your models.

Our companion notebook, Quickstart for model documentation,³ walks you through the steps of installing the library in your environment, initializing the library for use, and running a full suite of documentation tests that logs results to the ValidMind Platform.

³ Quickstart for model documentation

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 documentation 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_documentation.ipynb in your development 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_documentation.ipynb in your development 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-10 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to ​ValidMind!
📊 Model: [ValidMind] Model development quickstart (ID: cmbpnxrv6012o0g9w5049nsct)
📁 Document Type: model_documentation

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

Work with model documentation

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 Documentation:

   • Your model’s documentation is broken down into sections, defined by your documentation templates.⁹
   • Each section can be assigned a completion status,¹⁰ allowing you to track the progress of your documentation.

4. Click on any section of the documentation to review the test results and drafts of test result summaries generated by the ValidMind Library.

   In any subsection, expand the ​ValidMind Insights™ panel to view the Documentation Guidelines¹¹ that tell you more about what these sections mean and help you with the task of documenting the model as a developer.

5. Refine your model documentation by:

   • Adding or editing content blocks¹²
   • Adding additional test results after you’ve logged them¹³

⁸ Working with the model inventory

⁹ Working with templates

¹⁰ Assign documentation section statuses

¹¹ View documentation guidelines

¹² Work with content blocks

¹³ Work with test results

Example model details page with documentation outline

Populated model documentation section with the ​ValidMind Insights™ panel open

What’s next

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