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
andtags
attribute to theTest
base class for better categorization and filtering of tests. - Better filtering: Added a new
task_type
argument to thelist_tests()
function to allow simple filtering bytask_type
set in a test. - Clearer naming: Renamed
required_context
torequired_inputs
across the whole ValidMind SDK.
- Better test organization: Added a
- 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
anddefault_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. - Simplified test listing: The
vm.tests.list_tests()
function has been refined to show only theID
,Name
, andDescription
for each test, making it more user-friendly. - Detailed test descriptions: You can now obtain complete test details, including
required_context
anddefault_params
, using thevm.tests.describe_test()
function. - 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. - 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. - Easier required context: A complementary new method,
get_required_context()
, 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.
- Preview template expansion: With
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
To access the latest version of the ValidMind Platform UI, reload your browser tab.
To upgrade the ValidMind Developer Framework:
Using JupyterHub: Reload your browser tab and re-run the
%pip install --upgrade validmind
cell.In your own developer environment: Restart your notebook and re-run:
%pip install validmind