Document models

Generate model documentation starting with your model or model predictions, load your model or predictions into the developer framework, then finally view the results and refine your documentation in the platform UI to make it ready for approval.

Prerequisites

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

¹ Manage permissions

End-to-end workflow

In your modeling environment

1. Build your model or your model predictions.²

2. Export the datasets and model or predictions.

² No available model?
You can still run tests and log documentation with ValidMind as long as you’re able to load the model predictions.

With the ValidMind Developer Framework

1. From your modeling environment, load the trained datasets and models or predictions.

2. Install and initialize the client library.

3. Select the relevant tests.

4. Review if all tests are covered by ValidMind or your external test provider:

   • If all tests are NOT covered — Create and register additional tests.
   • If all tests are covered —
     1. Run the selected tests.
     2. Review your test results.

In the ValidMind Platform UI

1. After installing and initalizing the ValidMind Developer Framework,³ add content blocks⁴ to your model documentation:

   Select the block type:

   • For test-driven blocks — Select from available test provider results⁵

   • For text blocks —

     1. For new block:
        1. Add new editable text content block
        2. Review and collaborate on the content block
     2. For existing blocks: Select from available texts from content provider

2. Submit your model documentation for review.

³ Install and initialize the client library

⁴ Work with content blocks

⁵ Work with test results

What’s next

• Store project credentials in .env files
• Work with test results