June 22, 2023

Release highlights

This release includes a number of major enhancements to the ValidMind Developer Framework that will make it easier for users to edit templates and add custom tests that can be reused across templates.

In addition, this release also includes a new notebook to illustrate support for NLP models and PyTorch, as well as the ability to edit templates directly in the platform UI.

ValidMind Developer Framework (v1.15.4)

Implement your own custom tests

With support for custom tests, you can now go beyond the default set of documentation and testing components provided by ValidMind, and use our developer framework to document any type of model or use case.

Implement custom tests

Integrate external test providers

With test providers, you can now integrate external test libraries to expand the set of tests available through the ValidMind Developer Framework, or create your own test libraries.

Integrate external test providers

This enables registering custom tests under a namespace to make them available globally.
We provide a couple of demo scenarios with such test providers and show how you can register them with ValidMind so that they can run a template utilizing your tests.

Simplified documentation and testing using templates

Templates now function as dynamic test suites, allowing you to identify all the documentation components and test results mapped to a specific template.

This makes it easier to fill a pre-configured template (including boilerplates and spaces designated for documentation and test results) with a single command, instead of running multiple test suites.

Get started with the ValidMind Developer Framework

New notebook to illustrate natural language processing (NLP) data analysis and text classification use case

Learn how to use the ValidMind Framework to document and test an NLP data analysis and text classification model. The emphasis of this notebook is on documenting and testing the in-depth analysis and preprocessing of the text data, in this case, COVID-19 related tweets.

ValidMind Platform UI

Editable templates

You can now edit the documentation templates that get used for model documentation or for validation reports.

Customize documentation templates

This feature is relevant for administrators who need to configure templates for specific use cases, or where the existing templates supplied by ValidMind need to be customized.
Editing allows to configure sections, sub-sections, and content blocks inside a template.

Improved search

We improved the search feature in the platform UI to make search results more compact.

Enhancements

We revised our QuickStart guide to be more modular and to highlight that our suggested starting point with the ValidMind Developer Framework is now JupyterHub.

QuickStart

How to upgrade

ValidMind Platform UI

To access the latest version of the ValidMind Platform UI,¹ hard refresh your browser tab:

¹ Log in to ValidMind

Windows: Ctrl + Shift + R OR Ctrl + F5
MacOS: ⌘ Cmd + Shift + R OR hold down ⌘ Cmd and click the Reload button

ValidMind Developer Framework

To upgrade to the latest version of the ValidMind Developer Framework:²

² Get started with the ValidMind Developer Framework

In your Jupyter Notebook:
- Using JupyterHub:³ Hard refresh your browser tab.
- In your own developer environment:⁴ Restart your notebook.
Then within a code cell or your terminal, run:
```
%pip install --upgrade validmind
```

³ Try it with JupyterHub

⁴ Try it in your own developer environment

You may need to restart your kernel after running the upgrade package for changes to be applied.