Customizing Your
Model Inventory

Administrator Fundamentals — Module 2 of 4

Click to start

Learning objectives

“As an administrator who has set up our organization’s foundational units and granted users granulated access to the ValidMind Platform, I want to configure our model inventory and customize our reusable resources.”

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

Administrator Fundamentals

Module 2 — Contents

1. The ValidMind Platform model inventory
2. Configure model inventory fields
3. Customize reusable templates
4. Configure reusable blocks

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

• Prerequisite course
• Log in

To continue, you need to have been onboarded onto ValidMind Academy with the Customer Admin role and completed the first module of this course:

Onboarding Your Organization

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

1. Log in to check your access:

Log in to ​ValidMind

Be sure to return to this page afterwards.

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

The ValidMind inventory

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.

Typically, your development team will independently register models in your model inventory.

For this training course, you’ll register a dummy model via the Register Model modal to familiarize you with the ValidMind Platform interface and the model details page.

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

Register a new model

1. Select the option for a New Model.
2. You can fill in other options according to your preference.
3. Click Register Model to add the model to your inventory.

When you’re done, click to continue.

View model details

Once you’ve registered your model:

1. Select the name of your model you registered to open up the model details page.
2. Scroll through the page to explore the default layout, and the fields available out-of-the-box.

When you’re done, click to learn how to customize your model inventory.

Configure inventory fields

Manage model inventory fields

Learn more …

Try it live on the next pages.

Create and edit the fields that appear on all models in your model inventory. Choose from an array of field types with different properties and use cases.

• Add or edit inventory fields
• Inventory field types

1. In the left sidebar, click Settings.

2. Under Models, select Model Inventory Fields. Here you can edit existing inventory fields, or add a new one:

   • Click Add Field to add a new field.
   • Hover over a field and select Edit under the Actions column to edit that field.

3. Fields require a type, a name, and a description.

   • (Optional) You can also choose to indicate that a field is required on registration.
   • (Optional) You can also assign write permissions to allow granular access to editing this field gated by model stakeholder types.

4. When you are satisfied with the setup of your field, click Save.

Single Line Text

Simple text value.

Attachments

Upload supporting files for your model. Files must be less than 50 MB each in size.

Long Text

Toggle Enable rich text formatting to create a template using the rich text editor.

Single Select

Click Add Option to define a list of options.

Multiple Select

Click Add Option to define a list of options.

Checkbox

A true/false value set by a toggle.

Number

Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser’s locale. Select a number type:

• Simple — Define the decimal places that the number should be displayed up to and any large number abbreviations.
• Currency — Define the currency you would like the field to display in, as well as the decimal places that the number should be displayed up to and any large number abbreviations.

URL

Text value in valid URL format.

Date

• Date value in yyyy-mm-dd format.
• Selection is in the current user’s timezone; other users viewing this field will see the value automatically in their timezone.

Date Time

• Date value in yyyy-mm-dd, 24hr format.
• Selection is in the current user’s timezone; other users viewing this field will see the value automatically in their timezone.

Email

Text value in valid email (user@domain.com) format.

User

• Select list pre-populated with users from your User Directory.
• Toggle allow linking to multiple records on to allow multi-selection of users.

Calculation

Define a formula(params) function that automatically calculates and returns a value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory model fields.

1. Click in front of the inventory field to allow your formula access to the field’s values.
2. Replace the demonstration formula with your own in the code box provided.
3. Enter in sample values in the testing area then click Test Formula to validate your formula.

Add an inventory field

1. Click Add Field.
2. Select the field type, enter a name, and a description.
3. Click Save to add your field.

When you’re done, click to continue.

View model inventory field

1. Select the name of your model you registered earlier to open up the model details page.
2. On the landing page of your model, confirm that the new field that you added is present.

When you’re done, click to continue.

Manage model stakeholder types

Learn more …

Try it live on the next page.

Please note that the stock Model Developer, Model Owner, and Model Validator stakeholder types are required by default for all models, and as such cannot be cannot be modified.

Model stakeholders determine specific responsibilities and access levels for model review and approval processes for each model in your model inventory, such as read or edit access to model inventory fields.

Each model stakeholder also belongs to user groups which determine which models they can see, and have user roles with attached role permissions which define the level of access they have to overarching ValidMind Platform features.

• 1. Add model stakeholder types
• 2. Manage stakeholder type permissions

1. In the left sidebar, click Settings.

2. Under Models, select Model Stakeholder Types.

3. Click Add New Stakeholder Type.

4. Enter the unique name and description for the stakeholder type.

5. Once you click Add Type, you can proceed with managing the model inventory field permissions associated with that type.

1. Click on the stakeholder type whose permissions you want to change.

2. On the Permissions tab, you can:

   • View the current model inventory field permissions assigned to that type.
   • Select model inventory field permissions to be assigned to that type.

3. Select Edit Permissions to modify inventory field permissions to or from that type.

4. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission.

5. Click Save Permissions to apply your changes.

Add a model stakeholder type

1. Click Add New Stakeholder Type.
2. Enter the unique name and description for the stakeholder type.

When you’re done, click to continue.

Modify stakeholder field permissions

1. Click on the stakeholder type you added previously.
2. On the Permissions tab, select Edit Permissions to modify inventory field permissions to or from that type.
3. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission.
4. Click Save Permissions to apply your changes.

When you’re done, click to continue.

Customize reusable templates

Work with templates

Learn more …

Try it live on the next page.

Use ​ValidMind’s versioned documentation templates to ensure consistent and comprehensive model documentation, validation reports, and ongoing monitoring reports across all your models.

• View documentation templates
• Duplicate documentation templates

1. In the left sidebar, click Settings.

2. Under Documents, select Templates.

3. Select one of the following template types from the tabs:

   • Documentation
   • Validation Report
   • Ongoing Monitoring

4. Click on one of the available templates.

To duplicate an existing template and start with version one of that new template:

1. In the left sidebar, click Settings.

2. Under Documents, select Templates.

3. Select one of the tabs for the type of template you want to duplicate:

   • Documentation
   • Validation Report
   • Ongoing Monitoring

4. Click on the template to duplicate and on the template details page, select Duplicate Template.

5. In the Duplicate Template modal that opens, give your copy a template name and a template description.

6. Click Duplicate Template to create a copy of your template.

Once duplicated, customize your new template to your needs, making it available for use with model documentation, validation reports, or ongoing monitoring reports.

Duplicate a template

1. Select one of the tabs for the type of template you want to duplicate. For example: Documentation
2. Select the template to duplicate. For example: Binary classification
3. On the template details page, click Duplicate Template.
4. Give your copy a template name and a template description.
5. Click Duplicate Template to create a copy of your template.

When you’re done, click to continue.

Customize documentation templates

Learn more …

Try it live on the next page.

Customize ​ValidMind’s templates for model documentation, validation reports, and ongoing monitoring reports to fit your specific case-by-case needs, such as type or complexity of model or model use case.

1. In the left sidebar, click Settings.

2. Under Documents, select Templates.

3. Select one of the tabs for the type of template you want to edit:

   • Documentation
   • Validation Report
   • Ongoing Monitoring

4. Click the template to edit and on the template details page, select Edit Outline.

5. In outline editing mode, you can:

   1. Expand sections:
      • Expand the menu for any sections with subsections by clicking .
   2. Add content to sections: validation reports only
      • Click to add content to that section of the template, such as a Summary Block or a Guideline Block.
   3. Rename sections:
      • Hover over a section until the appears, then click on it to change the name.
      • Save by clicking , and discard changes by clicking .
   4. Insert new sections:
      • Click to add a new section or subsection to the template.
      • To add a section above the current section, select Section Before.
      • To add a section below the current section, select Section After.
      • To add a subsection within the current section, select Subsection.
   5. Remove sections:
      • Hover over the section you want to delete.
      • When the appears, click on it.
      • After you confirm, that section will be removed.
   6. Reorder sections:
      • Click and hold firmly to drag to reorder sections.

6. When you’re done, click Create New Version to view a side-by-side comparison of your changes with the previous version:

   • Add a description in version notes to track your changes.
   • Click Save to save the new version.

Once saved, your new template version becomes available for use.

Customize a template

1. Select one of the tabs for the type of template you want to edit. For example: Documentation
2. Select the template to edit. For example, the duplicate you created earlier: Copy of Binary classification
3. Click Edit Outline.
4. Make a modification to your template. For example: Add a 1.4 Feature Engineering subsection
5. Click Create New Version to view a side-by-side comparison of your changes with the previous version.
6. Add a description in version notes to track your changes.
7. Click Save to save the new version.

When you’re done, click to continue.

Configure reusable blocks

Manage text block library

Learn more …

Try it live on the next page.

By default, only the
Customer Admin role is able to add, edit, or delete shared text blocks.

Private blocks can be modified by any user role and are unique to that user.

Build a library of reusable text blocks to insert into your model documentation, validation reports, and ongoing monitoring reports. Reusable text blocks can be private, visible only to the user, or shared, accessible across your organization.

• Add text blocks
• Duplicate text blocks

To create a new text block via the block library:

1. In the left sidebar, click Settings.

2. Under Documents, select Block Library.

3. Click Add Block and enter:

   • The name of your text block
   • (Optional) A description for your text block
   • The templated content for your text block

4. Select a sharing option:

   • Private — Visible only to you
   • Shared — Accessible across your organization

5. Click Add Block to save your text block.

To make a copy of an existing text block in your block library:

1. In the left sidebar, click Settings.

2. Under Documents, select Block Library.

3. To the right of the text block you want to edit, click and select Duplicate Text Block.

4. Make your desired changes to the following fields:

   • The name of your text block
   • (Optional) A description for your text block
   • The templated content for your text block
   • Whether the block sharing permissions are Private or Shared

5. Click Duplicate Block to save the copy of your text block.

Add a shared text block

1. Click Add New Block and enter in the details for your text block.
2. Select the following sharing option: Shared
3. Click Add Block to save your text block.

When you’re done, click to continue.

Duplicate a text block for private use

1. Click the Shared Blocks tab.
2. To the right of the text block you created earlier, click and select Duplicate Text Block.
3. Make your changes to the details of the block, and select the following sharing option: Private
4. Click Duplicate Block to save a private copy of the text block.

When you’re done, click to continue.

In summary

Customizing your model inventory

In this second module, you learned how to:

• Configure your model inventory’s fields
• Define granular access to model inventory fields
• Customize and duplicate documentation templates
• Configure reusable blocks for use in templates

Continue your platform administration journey with:

​ValidMind for Model Risk Management