Work with test results

Published

September 4, 2024

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

Prerequisites

Add test results

  1. In the left sidebar, click Model Inventory.

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

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

    You can now jump to any section of the model documentation or validation report 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:

    A gif showing the process of adding a content block in the UI

  5. Click and then select Test-Driven Block.4

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

  6. Select test results using one of these methods:

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

    A screenshot showing several test-driven blocks that have been selected for insertion into the model documentation

    To preview what is included in a test, select it. By default, selected tests are previewed.

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

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

View test result metadata

After you have added a test result to your documentation, 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 Model Inventory.

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

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

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

  5. Under the test result’s name, click on the row indicating the date of the latest changes.

    • 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.

    A gif showcasing detail expansion of test runs on the test result timeline

What’s next