Model documents and templates

What kind of templates are provided by ​ValidMind?

​ValidMind provides the following default template types:¹

¹ Manage document templates

• Development (model documentation)
• Validation (validation reports)
• Monitoring (ongoing monitoring reports)

You can also create custom document types and associated templates to suit your organization’s unique needs.

Can templates be customized for our use cases?

Yes, the ValidMind Platform² allows you to configure versioned templates based on document requirements for each model or lifecycle use case.

² Accessing ​ValidMind

• ​ValidMind’s templates are fully customizable,³ and are complemented by the ability to manage validation guidelines.
• You can swap between different versions of templates or apply another version of the current template.⁴
• Template outlines can be modified right in the ValidMind Platform. We also offer an advanced raw YAML editor, enabling you to make detailed changes.

³ Customize document templates

⁴ Manage document templates

⁵ Manage permissions

By default, the Customer Admin role⁵ has sufficient permissions to manage document templates, and you must be a Developer or Validator to be able to swap document templates.

Can documents be created right in the ValidMind Platform?

Yes, you can work with model documentation, validation reports, ongoing monitoring reports, or any other document type directly in the ValidMind Platform, without having to first generate anything using the ValidMind Library.⁶

⁶ ValidMind Library

1. Add and edit text on any document within the platform using our content editing toolbar.⁷
2. Using the library, execute test suites and generate the corresponding supporting results. These results can then be added to your documents within the platform.⁸

⁷ Work with content blocks

⁸ Work with test results

Can I run tests and log documentation without a model?

Yes! If you do not have a model ready, or your model can’t be loaded directly, or you only have access to model predictions, you can still run tests and log documentation using the ValidMind Library as long as you’re able to load the model predictions.

• Use assign_predictions()⁹ to load predictions from a separate file or a dataset with predictions.
• Call init_model()¹⁰ but instead of a trained model instance, pass an input_id and model metadata. ModelMetadata()¹¹ will use the provided metadata instead of trying to calculate it from the model’s library.

⁹ assign_predictions()

¹⁰ init_model()

¹¹ ModelMetadata()

For example:

  external_model = vm.init_model(
      input_id="spark_ml_model",
      metadata={...}
  )

NoneIf neither a trained model instance nor metadata is provided, init_model() will return an error.

However, tests that need a trained model will not work with “empty” models.

Can we attach files to models, artifacts, or documents?

Yes, attachment type inventory fields are available for custom use.¹² Once created, attachment type fields allow you to upload supporting files to your model.

¹² Manage model inventory fields

• Out-of-the-box functionality is included for attaching files to model artifacts.
• You can also attach images to document content blocks and comments.

By default, the Customer Admin role has sufficient permissions to manage model inventory fields.

Do you support including images in model documents?

Yes, as long as you can produce the image with Python or open the image from a file, you can include it in your documents with ​ValidMind:¹³

¹³ Implement custom tests

• If you want to log an image as a test result, you can do so by passing the path to the image as a parameter to the custom test and then opening the file in the test function.
• If you are using a plotting library that isn’t directly supported by ​ValidMind, you can still return the image directly as a bytes-like object.

Can documents be exported?

Yes, ​ValidMind currently supports exporting documents in Word (.docx) format.¹⁴

¹⁴ Depending on the integration requirements of the systems used by your validation teams, such as connectivity via API, SharePoint, and more, ​ValidMind can work with you to automate the export and storage of documents into these systems.

Learn more