View documentation guidelines

View the guidelines for model documentation associated with a template to ensure that you are compliant with documentation requirements.

Prerequisites

• You are logged in to ValidMind.
• The model you are documenting is registered in the model inventory.¹
• Model documentation has already been created for this project.²
• A model developer has started generating documentation, either using the ValidMind Developer Framework³ or via the online editor in the ValidMind Platform UI.
• You are a Developer or assigned another role with sufficient permissions to perform the tasks in this guide.⁴

¹ Register models in the inventory

² Working with model documentation

³ ValidMind Developer Framework

⁴ Manage permissions

To configure documentation guidelines for templates, you must have sufficient guideline permissions.

By default, the Customer Admin role has these permissions.

Steps

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.

4. In any section of the documentation for a model, click ValidMind Insights™ in the top right corner to expand the ValidMind Insights™ sidebar.

   Documentation Guidelines are shown for each document section, associated with the template configured by your model validation team.

⁵ Working with the model inventory

What’s next

• Get started with the ValidMind Developer Framework
• Working with model documentation
• Collaborate on documentation