Using ​ValidMind
for Model Development

Developer Fundamentals — Module 1 of 4

Click to start

Learning objectives

“As a developer who is new to ​ValidMind, I want to learn how to register a model in the ValidMind Platform, install the ValidMind Library in my local environment, and preview my model’s documentation template.”


This first module is part of a four-part series:

Developer Fundamentals

Module 1 — Contents

  1. ​ValidMind for model development
  2. Register a model in the ValidMind Platform
  3. Install the ValidMind Library
  4. Preview your model’s documentation template

First, let’s make sure you can log in to ​ValidMind.

Training is interactive — you explore ​ValidMind live. Try it!

→ , ↓ , SPACE , N — next slide     ← , ↑ , P , H — previous slide     ? — all keyboard shortcuts

Before you begin

To continue, you need to have been onboarded onto ValidMind Academy with the Developer role.


Already logged in and refreshed this module? Click to continue.

  1. Log in to check your access:

Log in to JupyterHub

Log in to ​ValidMind

Be sure to return to this page afterwards.

  1. After you successfully log in, refresh the page to connect this training module up to the ValidMind Platform:


ValidMind for model development

Jupyter Notebook series

When you run these notebooks, they will generate a draft of model documentation and upload it to ​ValidMind, complete with supporting test results.

​ValidMind for model development

Our series of four introductory notebooks for model developers include sample code and how-to information to get you started with ​ValidMind:

1 — Set up the ValidMind Library
2 — Start the model development process
3 — Integrate custom tests
4 — Finalize testing and documentation

In this first module, we’ll run through 1 — Set up the ValidMind Library together.


Let’s start our journey with 1 — Set up the ValidMind Library on the next page.

1 — Set up the ValidMind Library

During this course, we’ll run through these notebooks together, and at the end of your learning journey you’ll have a fully documented sample model ready for review.

For now, scroll through this notebook to explore. When you are done, click to continue.

Register a model

Welcome to the ValidMind Platform

From here, you can:

  • Keep track of your models in the customizable inventory …
  • Review and edit model documentation generated via the ValidMind Library …
  • Collaborate with model validators to get your model approved …
  • … and much more!

Can’t load the ValidMind Platform?

Make sure you’re logged in and have refreshed the page in a Chromium-based web browser.

When you’re done navigating around, click to continue.

Welcome to the Inventory

Use the model inventory to track comprehensive details for all your models throughout the model lifecycle. The model inventory is customizable and extensible, with a layout that can be configured to suit your needs.

To start the documentation process, a model must already be registered in the model inventory via the Register Model modal.

Let’s register a model together on the next page.

Register a binary classification model

  1. Select the option for a new model:
  • Documentation template —
    Binary classification
  • Use case —
    Attrition/Churn Management

    You can fill in other options according to your preference.
  1. Click Register Model to add the model to your inventory.

When you’re done, click to continue.

Install the ValidMind Library

Get your code snippet

​ValidMind generates a unique code snippet for each registered model to connect with your developer environment:

  1. Select the name of your model you registered for this course to open up the model details page.
  2. On the left sidebar that appears for your model, click Getting Started.
  3. Locate the code snippet and click Copy snippet to clipboard.

When you’re done, click to continue.

Can’t load the ValidMind Platform?

Make sure you’re logged in and have refreshed the page in a Chromium-based web browser.

Install & initialize the ValidMind Library

With your code snippet copied to your clipboard:

  1. Open 1 — Set up the ValidMind Library: JupyterHub
  2. Run all the cells in the sections under Initializing the ValidMind Library.

When you’re done, return to this page and click to continue.

Preview model documentation

Preview the documentation template

You can preview your model’s documentation template right from the ValidMind Library:

  1. Continue with 1 — Set up the ValidMind Library: JupyterHub
  2. Run all the cells in the sections under Getting to know ValidMind.

When you’re done, return to this page and click to continue.

Document Overview

Learn more…


Try it live on the next page.

The Document Overview shows a section-by-section outline of your model’s documentation, as well as summaries of:

  • Any unresolved conversations
  • The number of model findings
  • The completion status for your model’s documentation
  • Recent activity on your model

To locate your document overview for a model:

  1. In the left sidebar, click Inventory.

  2. Select a model or find your model by applying a filter or searching for it.

  3. In the left sidebar that appears for your model, click Documentation.

Verify the documentation template

Once you’ve called preview_template():

  1. Select the name of your model you registered for this course to open up the model details page.
  2. On the left sidebar that appears for your model, click Documentation.
  3. Note how the structure of the Document Overview reflects the previewed template.

When you’re done, click to continue.

In summary

Using ​ValidMind for model development

In this first module, you learned how to:


Continue your model development journey with:

Learning to Run Tests