Using ​ValidMind
for 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 record (model) in the ValidMind Platform, install the ValidMind Library in my local environment, and preview my documentation template.”


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

Developer Fundamentals

Module 1 — Contents

  1. ​ValidMind for development
  2. Register a record (model) in the ValidMind Platform
  3. Install the ValidMind Library
  4. Preview your 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 development

Jupyter Notebook series

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

​ValidMind for development

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

1 — Set up the ValidMind Library
2 — Start the 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 record (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 records (models) in the customizable inventory …
  • Review and edit documentation generated via the ValidMind Library …
  • Collaborate with validators to get your records 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 exploring, click to continue.

Welcome to the Inventory

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

To start the documentation process, a record must already be registered in the inventory.

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

Register a sample model

  1. Enter some details for your sample model, then click Next .
  2. Select your own name under the record owner drop-down.
  3. Click Register Model to add the model to your inventory.

When you’re done, click to continue.

Apply a documentation template

Once you’ve registered your model, let’s select a documentation template. A template predefines sections for your documentation and provides a general outline to follow, making the documentation process much easier.

  1. Click on the name of the model you registered earlier.
  2. In the left sidebar that appears for your model, click Documents and select Development.
  3. Under create document, select Binary classification from the template drop-down menu.
  4. Click Use Template to apply the template.

If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (Learn more: Manage documents)

When you’re done, click to continue.

Install the
ValidMind Library

Get your code snippet

Initialize the ValidMind Library with the code snippet unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the library:

  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. Select Development from the document drop-down menu.
  4. 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 Setting up.

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

Preview documentation template

Get to know ​ValidMind

You can preview your model’s documentation template right from the ValidMind Library, as well as explore available tests without leaving your development environment:

  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 record’s documentation, as well as summaries of:

  • Any unresolved conversations
  • The number of associated artifacts
  • The completion status for your documentation
  • Recent activity on your record

Static PDF uploads do not include a Document Overview.

Only PDFs converted to editable documents, documents generated by the ValidMind Library, or documents created in the ValidMind Platform include a Document Overview.

To locate your document overview for a record:

  1. In the left sidebar, click Inventory.

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

  3. In the left sidebar that appears for your record, click Documents and select Development.

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 record details page.
  2. On the left sidebar that appears for your record, click Development under Documents.
  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 development

In this first module, you learned how to:


Continue your development journey with:

Learning to Run Tests