Explore sample model documentation

First, let’s take a look at how the ValidMind handles model documentation. The best place to start is with the ValidMind Platform.

ValidMind Platform main dashboard

The ValidMind Platform is the central place to:

• Work with model documentation and test results uploaded with the ValidMind Library.
• Prepare validation reports, work with model findings, and link evidence to findings.
• Collaborate with others, including model developers, model validators, and reviewers.

Before you begin

• To try out ValidMind, you need to be a registered user on the ValidMind Platform.
• Next, make sure you’re logged in to ValidMind .

Need an account for ValidMind?

Signing up is FREE — Register with ValidMind

Steps

1. In the left sidebar, click Inventory.

2. Locate or search for the [QuickStart] Customer Churn Model and click on it to select it.¹

3. On the model overview page that opens, you can find important information about the model, such as:

   • The use case
   • The owners, validators, developers, and business unit associated with the model
   • The risk tier, model status, and current version
   • Model findings, recent activity, and much more

   

   Landing page for the [QuickStart] Customer Churn Model

¹ Working with the model inventory

Note the initial model status.

This is the status that a model starts in as part of the default workflow, as defined by your organization.² You can click See Workflow to visualize the entire workflow that this model will go through.

² Working with model workflows

4. In the left sidebar that appears for the model, you can find links to:

   • The model’s Documentation³
   • The model’s Validation Report⁴
   • Ongoing Monitoring plans⁵ for that model
   • Any Model Findings⁶
   • All Model Activity⁷
   • And Getting Started information for integrating with the ValidMind Library⁸

5. In the left sidebar, 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.

6. Under 2. Data preparation, select 2.1. Data description.

   

   Data description page in the ValidMind Platform within a model’s documentation

   • This content is generated by the ValidMind Library and provides information about the dataset used, including histograms, information about dataset quality, and test results.
   • Sections that need your attention get flagged with Requires Attention. These sections get flagged automatically whenever a test result is above or below a certain threshold.

7. Expand 3. Model Development and any of the subsections to see information that has been uploaded by the library about:

   • Model Training
   • Model Evaluation
   • Model Explainability and Interpretability
   • Model Diagnosis
   1. If you expand the ValidMind Insights™ right sidebar, the Documentation Guidelines¹¹ can tell you more about what these sections mean and help you with the task of documenting the model as a developer.
   2. If you are a validator, this is also where you can add findings associated with a documentation section.¹²

8. Finally, take a look at section 4. Monitoring and Governance.

   Sections like 4.1 Monitoring Plan are not generated by the library, but they get added by the model developer in the platform. You can add both new text and test sections, called content blocks¹³ to your model documentation.

³ Working with model documentation

⁴ Preparing validation reports

⁵ Ongoing monitoring

⁶ Working with model findings

⁷ View model activity

⁸ Get started with the ValidMind Library

⁹ Working with documentation templates

¹⁰ Assign documentation section statuses

¹¹ View documentation guidelines

¹² Add and manage findings

¹³ Work with content blocks

What’s next

Continue with Register your first model to learn more about using the ValidMind Platform hands-on.