Work with content blocks

Make edits to your model documentation, validation reports, or ongoing monitoring plans by adding or removing content blocks directly in the online editor.

What are content blocks?

Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, and ongoing monitoring plans.

• You can think of these sections as an empty canvas that you fill in with text and test results.
• Multiple sections are joined to create a longer document with a table of contents that has different heading and subheading levels, such as “1.,” “1.1.,” and so on.

Content block types

simple text block

Can be added anywhere on model documentation, validation reports, or ongoing monitoring plans and edited to include additional documentation in text format.

test-driven block

Can be within model documentation and ongoing monitoring plans to display one of the supported test results collected by the ValidMind Developer Framework.

metric over time block

Can be added within model documentation and ongoing monitoring plans to display one of the supported metric over time results collected by the developer framework.

Content editing toolbar

Content editing toolbar

The content editing toolbar is a rich text editor that enables you to:

• Undo or redo changes
• Format your text, including adding hyperlinks and code blocks
• Insert LaTex formulas¹
• Attach images via upload or URL

¹ Add mathematical formuals

² Collaborate with others

You can also use the toolbar to suggest changes, save named versions of content, and leave comments.²

Stuck on where to start?

Use ValidMind to assist you with generating content via AI!³

³ Generate with AI (BETA)

Prerequisites

• You are logged in to ValidMind.
• The model you are documenting or validating is registered in the model inventory.⁴
• You are a Developer or Validator, or assigned another role with sufficient permissions to perform the tasks in this guide.⁵

⁴ Register models in the inventory

⁵ Manage permissions

Add content blocks

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.

   You can now jump to any section of the model documentation, validation report, or ongoing monitoring plan by expanding the table of contents on the left and selecting the relevant section you would like to add content to, such as 1.1 Model Overview.

4. Hover your mouse over the space where you want your new block to go until a horizontal dashed line with a sign appears that indicates you can insert a new block:

   

   Adding a content block in the UI

5. Click and then select one of the available options:

   • Text — Adds a new section with a blank content block. After the new content block has been added, click to edit the contents of the section like any other.
   • Test-Driven⁷ — Adds a new section with test results.
   • Metric Over Time⁸ — Adds a new section with metric over time results.

6. After adding the block to your documentation, click on the text to make changes or add comments.⁹

⁶ Working with the model inventory

⁷ Work with test results

⁸ Work with metrics over time

⁹ Collaborate with others

Add mathematical formulas

While editing a simple text block, you can insert math equations using the editor:

1. Click √ in the toolbar while editing a content block.

2. You can use the interface to type out the equation, or paste in a LaTeX formula:

Inserting a mathematical formula using LaTex within a simple text block

3. Click Insert to add the equation to your content block.

Generate Text with AI ^beta

While editing a simple text block, you can have ValidMind assist you with generating content drafts:

1. Click ^beta (Generate Text with AI) in the toolbar while editing a content block.

2. Enter an optional prompt to guide the output, then click Generate to compose a draft for review.

3. Review the draft composed by the ValidMind AI Content Builder for accuracy and relevance, then:

   • Click Accept Text to insert the draft into your content block.
   • Click Try Again to regenerate a different draft.
   • Click Cancel to discard the draft and return to your documentation section.

4. After you insert the AI-generated draft, click on the text box to make the necessary edits and adjustments to your copy:

   • Ensure that content is in compliance with the quality guidelines outlined by your organization.
   • Use the content editing toolbar¹⁰ just as you would with any other text block.

¹⁰ Content editing toolbar

Generating content with AI within a simple text block

When generating content drafts with AI, accepted versions and edits are retained in your Model Activity¹¹ just like other updates to your documentation, reports, or plans.

¹¹ View model activity

Remove content blocks

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.

   You can now jump to any section of the model documentation or validation report by expanding the table of contents on the left and selecting the relevant section, such as 1.1 Model Overview.

4. Select the block you wish to remove from the model documentation.

5. Click on located in either one of these locations:

   • In the toolbar for text blocks

   

   Deleting a content block via the text toolbar

   • In the single-button toolbar for test-driven or metric over time blocks

   

   Deleting a content block via the single-button toolbar for test-driven blocks

6. After you confirm, the content block is removed.

   Test-driven or metric over time blocks can be re-added later on but text blocks are currently deleted permanently.

¹² Working with the model inventory

What’s next

• Register models in the inventory
• Working with model documentation
• Preparing validation reports
• View model activity