Working with documentation

After you upload initial documentation through the ValidMind Library as part of your development process, use the ValidMind Platform to make qualitative edits to documentation, collaborate with other stakeholders, and submit your work for review.

NoneLooking to get started as a developer?

This section describes how to work with Development type documents¹ (for example, model documentation) in the ValidMind Platform. Typically, you perform the tasks described here after you have uploaded some initial documentation with the ValidMind Library.

Learn more about the ValidMind Library

¹ Manage document types

Prerequisites

• You are logged in to ValidMind.
• The record you are documenting is registered in the inventory.²
• You have provided some content for the documentation, either by uploading it through the library³ or via the platform.
• You are a Developer or assigned another role with sufficient permissions to perform the tasks in this guide.⁴

² Register records in the inventory

³ ValidMind Library

⁴ Manage permissions

Key concepts

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

For example, documentation for models typically include sections on:

conceptual soundness

Establishes the foundation of a selected record such as a model, covering the overview, intended use and business use case, regulatory requirements, limitations, and the rationale behind selection. It emphasizes purpose, scope, and constraints, which are crucial for stakeholders to understand 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 training, ensuring that the record such as a model is built on a solid and relevant dataset.

model development, development

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

monitoring and governance

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

Document Overview

NoneStatic PDF uploads do not include a Document Overview.

Only PDFs converted to editable documents,⁵ documents generated by the ValidMind Library, or documents created in the ValidMind Platform include a Document Overview.

⁵ Manage documents

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

• Any unresolved conversations⁶
• The number of associated artifacts⁷
• The completion status for your documentation⁸
• Recent activity on your record⁹

⁶ Collaborate with others

⁷ Working with artifacts

⁸ Assign section statuses

⁹ View record activity

To locate your document overview for a record:

1. In the left sidebar, click Inventory.

2. Select a record or find your record by applying a filter or searching for it.¹⁰

3. In the left sidebar that appears for your record, click Documents and select the Latest or Saved Versions tab.¹¹

4. Click on a Development type file.¹²

¹⁰ Working with the inventory

¹¹ Work with document versions

¹² Working with documents

Add or edit documentation

NoneStatic PDF uploads cannot be edited.

Only PDFs converted to editable documents,¹³ documents generated by the ValidMind Library, or documents created in the ValidMind Platform can be edited.

¹³ Manage documents

¹⁴ Work with document versions

Modify the contents of the Latest version of your document:¹⁴

1. From the Document Overview, jump to any section of the documentation by clicking on the heading you would like to view.

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

   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.

Prepare documentation

Draft, edit, and refine your documentation, complete with supporting test results:

Wrap up your documentation, collaborate with other stakeholders, and submit your work for review: