Working with model documentation

After you upload initial model documentation through the developer framework, use the platform UI to make qualitative edits to model documentation, view guidelines, collaborate with validators, and submit your model documentation for approval.

Looking to get started as a model developer?

This section describes how to work with model documentation in the ValidMind Platform UI. Typically, you perform the tasks described here after you have uploaded some initial model documentation with the ValidMind Developer Framework.

Get started with the ValidMind Developer Framework

Prerequisites

• You are logged in to ValidMind.
• The model is already registered in the model inventory.¹
• You have provided some content for the documentation, either by uploading it through the ValidMind Developer Framework² or via the online UI editor.
• You are a Developer or assigned another role with sufficient permissions to perform the tasks in this guide.³

¹ Register models in the inventory

² ValidMind Developer Framework

³ Manage permissions

Key concepts

Each section of your model documentation should address critical aspects of the model’s lifecycle, from conceptualization and data preparation through development and ongoing management. This comprehensive documentation approach is essential for ensuring the model’s reliability, relevance, and compliance with business and regulatory standards.

conceptual soundness

Establishes the foundation of the model, covering the model overview, intended use and business use case, regulatory requirements, model limitations, and the rationale behind the model selection. It emphasizes the model’s purpose, scope, and constraints, which are crucial for stakeholders to understand the model’s applicability and limitations.

data preparation

Details the data description, including dataset summary, data quality tests, descriptive statistics, correlations and interactions, and feature selection and engineering. It provides transparency into the data used for model training, ensuring that the model is built on a solid and relevant dataset.

model development

Discusses the model training, evaluation, explainability, interpretability, and diagnosis, including model weak spots, overfit regions, and robustness. This section is vital for understanding how the model was developed, how it performs, and its areas of strength and weakness.

monitoring and governance

Focuses on the model’s ongoing monitoring plan, implementation, and governance plan. It outlines strategies for maintaining the model’s performance over time and ensuring that it remains compliant with regulatory requirements and ethical standards.

Document Overview⁴

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. 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
   • Recent activity on your model

Add or edit documentation

1. From the Document Overview, jump to any section of the model documentation by selecting the relevant section you would like to view.

2. In any section of the documentation, click to add or edit content.

   You can now use the text editor functions to edit the content of the section. Whenever you make a change, an activity log entry is recorded under Section activity on the page, just below the section you are editing.

3. Save your edits as a revision:

   1. Click on the icon in the editor toolbar.
   2. Select Save current revision and enter a name.
   3. Click to save the current revision.

⁴ 
• Review model documentation
• Collaborate with others
• Work with model findings
• Assign section statuses
• View documentation activity

What’s next