Review model documentation

Published

June 13, 2024

You review the model documentation provided by a model developer as part of the formal validation process.

Prerequisites

  • You hold the Validator role
  • A model developer has submitted model documentation for review

Document Overview

  1. Log in to the ValidMind UI.

  2. In the left sidebar, click Model Inventory.

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

  4. In the left sidebar that appears for your model, click Documentation.

    This is the Document Overview. This page shows a section-by-section outline of your project’s documentation, as well as summaries of:

    • Any unresolved conversations
    • The number of model findings
    • The completion status for your model’s documentation

Unresolved conversations

Here on this documentation overview page, hover over the # icon to see a preview of the unresolved conversation associated with the documentation section.

Resolve conversations directly from this popup, or click to expand the conversation. Learn more …

Model findings

Here on this documentation overview page, hover over over the # icon to see a preview of model findings associated with the documentation section.

Click to expand the finding. Learn more …

Recent activity

At the bottom of the Document Overview page, you will also see quick view of any documentation activity.

Click on See all Activity to be taken to the Model Activity page.