Swap documentation templates

Swap between different versions of your model documentation or validation report templates within the ValidMind Platform UI. Switch to a completely different template, or apply another version of your current template.

• When swapping templates, only the document structure is changed. Any modifications that you might have made to content is preserved inside each content block or section.
• If you are not sure which template or which version of a template your model documentation or validation report is using, you can also check and compare between different templates and versions of templates.

Prerequisites

• You are logged in to ValidMind.
• You are a Developer or Validator, or assigned another role with sufficient permissions to perform the tasks in this guide.¹

¹ Manage permissions

View current templates

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, Validation Report, or Ongoing Monitoring.

4. On your Document Overview. Validation Report Overview, or Ongoing Monitoring page, locate:

   • document template — Lists the template used for model documentation.³
   • validation report template — Lists the template used for validation reports.⁴
   • ongoing monitoring template — Lists the template used for ongoing monitoring plans.⁵

² Working with the model inventory

³ Working with model documentation

⁴ Preparing validation reports

⁵ Ongoing monitoring

Swap templates

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, Validation Report, or Ongoing Monitoring.

4. On your Document Overview, Validation Report Overview, or Ongoing Monitoring page click on the name and the version of the template under:

   • Document Overview — document template⁷
   • Validation Report — validation report template⁸
   • Ongoing Monitoring — ongoing monitoring template⁹

   The window pane that opens shows the YAML for the current template along with other information, such as the name and the current version,¹⁰ and which models are using this template.

5. Click Swap Template.

   The window pane now shows the YAML for two templates side-by-side:

   • On the left, your current template is shown.
   • On the right, you can select a different template and version.

   Initially, both templates are the same.

6. On the right, select a different template or version:

   • template — Change to a different template entirely.
   • version — Change to a different version of the template you selected.

   For example, select a newer version of the template currently in use to switch to that version.

   After you select a different template or version, the YAML differences between the templates are highlighted.

7. Click Prepare Swap.

8. Enter a note to enable completing the swap and click Swap Template.

⁶ Working with the model inventory

⁷ Working with model documentation

⁸ Preparing validation reports

⁹ Ongoing monitoring

¹⁰ Customize documentation templates

Swapping a documentation template version

After your model documentation template has been swapped successfully, you can continue to work on your model documentation.

Reusing old content

If you added a simple text block to your old template and want to reuse the content, you can temporarily switch back to the old template, copy the content, swap back to the new template, and then paste in the content.

What’s next

• Customize documentation templates
• Working with model documentation