Work with test results

Once generated via the ValidMind Library, view and add the test results to your documentation in the ValidMind Platform.

Prerequisites

• You are logged in to ValidMind.
• Test results have already been documented via the ValidMind Library for your model.¹
• You are a Developer or Validator, or assigned another role with sufficient permissions to perform the tasks in this guide.²

¹ Document models

² Manage permissions

Add test results

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, Validation Report, or Ongoing Monitoring.

   You can now jump to any section of the model documentation, validation report, or ongoing monitoring plan by expanding the table of contents on the left and selecting the relevant section you would like to add content to, such as 1.1 Model Overview.

4. Hover your mouse over the space where you want your new block to go until a horizontal dashed line with a sign appears that indicates you can insert a new block:

   

   Adding a content block in the UI

5. Click and then select Test-Driven.⁴

   • By default, the Developer role can add test-driven blocks within model documentation or ongoing-monitoring plans.
   • By default, the Validator role can add test-driven blocks within validation reports.

6. Select test results:

   • Select the tests to insert into the model documentation from the list of available tests.
   • Search by name using Search on the top-left to locate specific test results.

   

   Test-driven blocks that have been selected for insertion

   To preview what is included in a test, click on it. By default, the actively selected test is reviewed.

7. Click Insert # Test Results to Document when you are ready.

8. After inserting the results into your document, click on the text to make changes or add comments.⁵

³ Working with the model inventory

⁴ Work with content blocks

⁵ Collaborate with others

View test result metadata

After you have added a test result to your document, you can view the following information attached to the result:

• History of values for the result
• What users wrote those results
• Relevant inputs associated with the result

1. In the left sidebar, click Inventory.

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

3. In the left sidebar that appears for your model, click Documentation, Validation Report, or Ongoing Monitoring.

4. Locate the test result whose metadata you want to view.

5. Under the test result’s name, click on the row indicating the currently Active test result.

   • On the test result timeline, click on the associated with a test run to expand for details.
   • When you are done, you can either click Cancel or to close the metadata menu.

   

   Detail expansion of test runs on the test result timeline

⁶ Working with the model inventory

Filter historical test results

By default, test result metadata are sorted by date run in descending order. The latest result is automatically indicated as Active.

To narrow down test runs, you can apply some filters:

1. On the detail expansion for test result metadata, click Filter.

2. On the Select Your Filters dialog that opens, enter your filtering criteria for:

   • Date range
   • Model
   • Dataset
   • Run by

3. Click Apply Filters.

Filters can be removed from the list of test result metadata by clicking on the next to them.

What’s next

• Working with model documentation
• Work with content blocks
• Collaborate with others
• View model activity