Review model documentation

Published

October 3, 2024

Use the ValidMind Platform UI to review the model documentation provided by a model developer as part of the formal validation process.

Prerequisites

Key concepts

review
Entails a comprehensive evaluation process covering four key aspects of model documentation to ensure thoroughness, compliance, and reliability:
  • Conceptual soundness — Examines the foundational elements of the model, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the model’s purpose, scope, and constraints are well-defined and understood by stakeholders.

  • Data preparation — Assesses the quality and preparation of the data used for model training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the model is built on a robust and relevant dataset.

  • Model development — Focuses on the model’s development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the model’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically.

  • Monitoring and governance — Evaluates the ongoing strategies for monitoring the model’s performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the model’s efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the model’s documented results.

These elements collectively ensure that the model documentation is thorough, transparent, and meets all necessary standards and regulatory requirements.

Document Overview

The Document Overview shows a section-by-section outline of your model’s documentation, as well as summaries of:

  • Any unresolved conversations3
  • The number of model findings4
  • The completion status for your model’s documentation5
  • Recent activity on your model6

To locate your document overview for a model:

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

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

Unresolved conversations

Hover over # Unresolved conversations 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.

Model findings

Hover over # Model Findings to see a preview of model findings associated with the documentation section.

Click to expand the finding.

Completion status

The #/# Done indicator reflects the completion status of your documentation sections.

Recent activity

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

Use the top tabs to narrow down the recent activity.

What’s next