PR Summary

This pull request introduces several enhancements to the documentation and model management features of the ValidMind platform. Key changes include:

1. Documentation Enhancements:

   • Added support for viewing test result metadata directly in model documentation, including history of values, user attribution, and relevant inputs.
   • Introduced a new Document Overview page to help users find information more quickly, with improved navigation and data visualization.
   • Implemented a new documentation outline page with a section-by-section view and unresolved conversation counts.
   • Enhanced the template management experience with a visual editor for adding, removing, and renaming sections.

2. Model Management Improvements:

   • Added the ability to flag models as vendor models and specify vendor names during registration.
   • Improved Model Inventory filters for better usability.
   • Introduced customizable model workflows for managing lifecycle processes.
   • Enhanced workflow customization with more granular management and integration with model inventory attributes.

3. New Features:

   • Support for running documentation tests without a Python-native model object, allowing documentation of models developed in non-Python environments.
   • New metric decorator for creating custom tests with minimal boilerplate code.
   • Added support for composite tests by combining multiple unit tests into complex outputs.
   • Introduced new text data validation tests for language detection, toxicity, polarity, subjectivity, and sentiment.

4. User Management Enhancements:

   • Improved user group management with support for creating new groups and adding members during creation.
   • Enhanced user invitation history display with separate tables for pending and accepted invites.

5. Bug Fixes:

   • Fixed issues with template validation for duplicate section IDs.
   • Resolved UI issues with incorrect messages and menu visibility based on user roles.

These changes aim to improve the overall user experience, streamline documentation and model management processes, and enhance the platform's flexibility and usability.

Test Suggestions

• Test the new Document Overview page for navigation and data visualization improvements.
• Verify the functionality of the new documentation outline page with section-by-section view and conversation counts.
• Check the template management experience for adding, removing, and renaming sections using the visual editor.
• Test the ability to flag models as vendor models and specify vendor names during registration.
• Validate the improved Model Inventory filters for usability.
• Ensure the customizable model workflows function as expected for managing lifecycle processes.
• Test the new metric decorator for creating custom tests.
• Verify the functionality of composite tests by combining multiple unit tests.
• Test the new text data validation tests for language detection, toxicity, polarity, subjectivity, and sentiment.
• Check the user group management enhancements for creating new groups and adding members.
• Verify the user invitation history display for pending and accepted invites.

A PR preview is available: Preview URL

PR Summary

This pull request introduces several enhancements to the documentation and model management features of the ValidMind platform. Key changes include:

1. Documentation Enhancements:

   • Added support for tracking each test result with a unique identifier in documentation templates, allowing for multiple results from the same test across different datasets or models.
   • Improved the run_documentation_tests() function to allow easier specification of inputs for individual tests.
   • Introduced new endpoints to list available task types and tags for filtering tests.
   • Enhanced the developer framework to track datasets and models used in tests, linking them with test results for better transparency.

2. Platform Enhancements:

   • Updated events to show the user who ran actions in the developer framework, improving accountability.
   • Simplified instructions for developers to get started with the ValidMind Developer Framework.
   • Enabled model owners to edit model details, including default fields.
   • Improved performance and search functionality in the platform.
   • Added support for custom model fields in the model inventory, allowing organizations to tailor the data schema to their needs.
   • Expanded rich-text editor support to more sections, including findings and validation reports.

3. Bug Fixes:

   • Resolved issues with invalid content blocks in run_documentation_tests().
   • Fixed display issues in the documentation table of contents and template swap diffs.
   • Corrected activity item links to direct users to the correct content block.

4. Documentation Updates:

   • Added new user management documentation, covering tasks like inviting users and managing roles.
   • Updated sample notebooks to reflect current input_id usage.

These changes aim to enhance the usability, flexibility, and transparency of the ValidMind platform, particularly in the areas of documentation and model management.

Test Suggestions

• Test the unique identifier feature in documentation templates by running the same test on different datasets and verifying the results are logged separately.
• Verify that the run_documentation_tests() function correctly accepts and applies individual test inputs and parameters.
• Check the new endpoints for listing task types and tags to ensure they return accurate and complete data.
• Test the updated event logging to confirm that user actions are correctly attributed in the platform.
• Ensure that model owners can edit all intended fields and that changes are saved correctly.
• Test the performance improvements by comparing load times before and after the update.
• Verify that custom model fields can be added, edited, and removed as expected.
• Check the rich-text editor functionality in findings and validation reports for any formatting issues.