August 15, 2023

Release highlights

This release includes a number of improvements for the developer experience when using the ValidMind Developer Framework, along with a visual redesign of the ValidMind Platform UI.

ValidMind Developer Framework (v1.17.0)

Improved developer experience for the Metric test class

We made a number of enhancements to the ValidMind Developer Framework to improve the experience for developers.

Better test organization

Added a metadata and tags attribute to the Test base class for better categorization and filtering of tests.

Test()

Better filtering

Added a new task_type argument to the list_tests() function to allow simple filtering by task_type set in a test.

list_tests()

Clearer naming

Renamed required_context to required_inputs across the whole ValidMind SDK.

Enhancements to test configuration discovery

To make the discovery of required context and default configuration easier, this update includes a number of changes to how required_context and default_parameters are presented.

Preview template expansion

With vm.preview_template(), you can now view detailed, expandable information for each content block driven by a test. This includes the test’s name, description, required context, and default parameters.

preview_template()

Simplified test listing

The vm.tests.list_tests() function has been refined to show only the ID, Name, and Description for each test, making it more user-friendly.

list_tests()

Detailed test descriptions

You can now obtain complete test details, including required_context and default_params, using the vm.tests.describe_test() function.

describe_test()

Retrieve test suite

The new function vm.get_test_suite() allows you to access a specific test suite instance via the high-level ValidMind API.

get_test_suite()

Access to default configuration

A new method, get_default_config(), is now part of both the TestPlan and TestSuite classes, letting you obtain a dictionary containing all the configuration parameters used by the tests.

get_default_config()

Easier required context

A complementary new method, get_context_data(), now returns a list of all the context variables needed for tests to run, making it easier for you to ensure that everything is set up correctly.

TestContext

ValidMind Platform UI (v1.4.10)

Redesigned application and navigation bar layout

  • The new application design offers a cleaner, more intuitive interface that enhances user experience.
  • The updated navigation bar layout specifically contributes to easier navigation, allowing users to find what they need with greater efficiency.

How to upgrade

ValidMind Platform UI

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

  • 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:2

  1. In your Jupyter Notebook:

    • Using JupyterHub:3 Hard refresh your browser tab.
    • In your own developer environment:4 Restart your notebook.

  2. Then within a code cell or your terminal, run:

    %pip install --upgrade validmind

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