Publishing to prod — Feb 03, 2035

.github/actions/demo-notebook/action.yml

@@ -6,9 +6,9 @@ inputs:
     description: "Load the created .env file"
     required: true
 
-runs: 
+runs:
   using: "composite"
-  steps: 
+  steps:
     - name: Install python3 for Jupyter Notebooks
       shell: bash
       run: |
@@ -18,10 +18,11 @@ runs:
     - name: Install validmind for notebook execution
       shell: bash
       run: |
-        pip install validmind 
-        pip install validmind[llm] 
-        pip install fairlearn aequitas 
+        pip install validmind
+        pip install validmind[llm]
+        pip install fairlearn aequitas
         pip install shap==0.44.1
+        pip install anywidget
 
     - name: Ensure .env file is available
       shell: bash
@@ -36,9 +37,9 @@ runs:
       shell: bash
       if: ${{ steps.find_env.outcome == 'success' }}
       run: |
-          cd site 
+          cd site
           source ../${{ inputs.env_file }}
-          quarto render --profile exe-demo notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || { 
+          quarto render --profile exe-demo notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
           echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
           cat render_errors.log;
           exit 1;

.github/actions/prod-notebook/action.yml

@@ -6,9 +6,9 @@ inputs:
     description: "Load the created .env file"
     required: true
 
-runs: 
+runs:
   using: "composite"
-  steps: 
+  steps:
     - name: Install python3 for Jupyter Notebooks
       shell: bash
       run: |
@@ -18,10 +18,11 @@ runs:
     - name: Install validmind for notebook execution
       shell: bash
       run: |
-        pip install validmind 
-        pip install validmind[llm] 
-        pip install fairlearn aequitas 
+        pip install validmind
+        pip install validmind[llm]
+        pip install fairlearn aequitas
         pip install shap==0.44.1
+        pip install anywidget
 
     - name: Ensure .env file is available
       shell: bash
@@ -36,9 +37,9 @@ runs:
       shell: bash
       if: ${{ steps.find_env.outcome == 'success' }}
       run: |
-          cd site 
+          cd site
           source ../${{ inputs.env_file }}
-          quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || { 
+          quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
           echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
           cat render_errors.log;
           exit 1;

.github/actions/staging-notebook/action.yml

@@ -6,9 +6,9 @@ inputs:
     description: "Load the created .env file"
     required: true
 
-runs: 
+runs:
   using: "composite"
-  steps: 
+  steps:
     - name: Install python3 for Jupyter Notebooks
       shell: bash
       run: |
@@ -18,10 +18,11 @@ runs:
     - name: Install validmind for notebook execution
       shell: bash
       run: |
-        pip install validmind 
-        pip install validmind[llm] 
-        pip install fairlearn aequitas 
+        pip install validmind
+        pip install validmind[llm]
+        pip install fairlearn aequitas
         pip install shap==0.44.1
+        pip install anywidget
 
     - name: Ensure .env file is available
       shell: bash
@@ -36,9 +37,9 @@ runs:
       shell: bash
       if: ${{ steps.find_env.outcome == 'success' }}
       run: |
-          cd site 
+          cd site
           source ../${{ inputs.env_file }}
-          quarto render --profile exe-staging notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || { 
+          quarto render --profile exe-staging notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb &> render_errors.log || {
           echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
           cat render_errors.log;
           exit 1;

.github/workflows/deploy-docs-prod.yaml

@@ -28,8 +28,8 @@ jobs:
 
       - name: Render prod docs site
         run: |
-            cd site 
-            quarto render --profile production &> render_errors.log || { 
+            cd site
+            quarto render --profile production &> render_errors.log || {
             echo "Quarto render failed immediately";
             cat render_errors.log;
             exit 1;
@@ -39,11 +39,11 @@ jobs:
         id: create_env
         run: |
           touch .env
-          echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env 
-          echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env 
-          echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env 
-          echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env 
-          cat .env 
+          echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
+          echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
+          echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
+          echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
+          cat .env
 
       # Only execute the prod notebook if .env file is created
       - name: Execute prod Intro for Model Developers notebook

.github/workflows/deploy-docs-staging.yaml

@@ -28,8 +28,8 @@ jobs:
 
       - name: Render staging docs site
         run: |
-            cd site 
-            quarto render --profile staging &> render_errors.log || { 
+            cd site
+            quarto render --profile staging &> render_errors.log || {
             echo "Quarto render failed immediately";
             cat render_errors.log;
             exit 1;
@@ -39,11 +39,11 @@ jobs:
         id: create_env
         run: |
           touch .env
-          echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env 
-          echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env 
-          echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env 
-          echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env 
-          cat .env   
+          echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
+          echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
+          echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
+          echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
+          cat .env
 
       # Only execute the staging notebook if .env file is created
       - name: Execute staging Intro for Model Developers notebook

.github/workflows/validate-docs-site.yaml

@@ -27,8 +27,8 @@ jobs:
 
     - name: Render demo docs site
       run: |
-          cd site 
-          quarto render --profile development &> render_errors.log || { 
+          cd site
+          quarto render --profile development &> render_errors.log || {
           echo "Quarto render failed immediately";
           cat render_errors.log;
           exit 1;
@@ -52,21 +52,21 @@ jobs:
       id: create_env
       run: |
         touch .env
-        echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env 
-        echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env 
-        echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env 
-        echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env 
-        cat .env   
+        echo VM_API_HOST=${{ secrets.PLATFORM_API_HOST }} >> .env
+        echo VM_API_KEY=${{ secrets.PLATFORM_API_KEY }} >> .env
+        echo VM_API_SECRET=${{ secrets.PLATFORM_API_SECRET }} >> .env
+        echo VM_API_MODEL=${{ secrets.PLATFORM_DEV_MODEL }} >> .env
+        cat .env
 
     # Only execute the demo notebook if .env file is created
     - name: Execute demo Intro for Model Developers notebook
-      if: ${{ steps.create_env.outcome == 'success' }}
+      if: ${{ env.ENABLE_DEMO_NOTEBOOK == 'true' && steps.create_env.outcome == 'success' }}
       uses: ./.github/actions/demo-notebook
       id: execute-demo-notebook
       with:
         env_file: .env
 
-    - name: Test for warnings or errors 
+    - name: Test for warnings or errors
       run: |
         if grep -q 'WARN:\|ERROR:' site/render_errors.log; then
           echo "Warnings or errors detected during Quarto render"
@@ -76,7 +76,7 @@ jobs:
           echo "No warnings or errors detected during Quarto render"
         fi
 
-      # Demo bucket is in us-east-1  
+      # Demo bucket is in us-east-1
     - name: Configure AWS credentials
       run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY }} && aws configure set default.region us-east-1
 

README.md

@@ -26,7 +26,8 @@ You need:
 
 ## How to contribute
 
-First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
+> [!IMPORTANT]
+> First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
 
 - Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide). 
 - If you create new documentation, make sure to add it to the [`_quarto.yml`](https://github.com/validmind/documentation/blob/main/site/_quarto.yml) file.
@@ -133,7 +134,8 @@ make get-source
 
 After you pull in the changes, commit them to this repo as part of the release notes process.
 
-**Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
+> [!TIP]
+> **Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
 
 <!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->
 

site/_quarto.yml

@@ -170,6 +170,7 @@ website:
         - text: "---"
         - text: "Releases"
         # MAKE-RELEASE-NOTES-EMBED-MARKER
+        - releases/2025/2025-jan-31/release-notes.qmd
         # CURRENT-YEAR-END-MARKER
         - file: releases/2024/2024-releases.qmd
           contents:

site/developer/model-testing/testing-overview.qmd

@@ -51,6 +51,9 @@ listing:
     contents: 
     - ../../notebooks/code_samples/custom_tests/implement_custom_tests.ipynb
     - ../../notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
+    - path: /notebooks/how_to/add_context_to_llm_descriptions.ipynb
+      title: "Add context to LLM-generated test descriptions"
+      description: "Learn how to add custom use case and test-specific context to your LLM-generated test descriptions."
 ---
 
 {{< var vm.product >}} provides many built-in tests and test suites, which help you produce documentation during stages of the model development lifecycle where you need to validate that your work satisfies MRM (model risk management) requirements.

site/faq/faq-testing.qmd

@@ -38,6 +38,11 @@ Yes, {{< var vm.product >}} allows tests to be manipulated at several levels:
 - You can change the thresholds and parameters for default tests already available in the {{< var vm.developer >}} — for instance, changing the threshold parameter for the class imbalance flag.[^5]
 - You can also connect your own custom tests with the {{< var validmind.developer >}}. These custom tests are configurable and are able to run programmatically, just like the rest of the {{< var vm.developer >}}.[^6]
 
+::: {.callout}
+In addition to custom tests, you can also add use case and test-specific context for any test to enhance the LLM-generated test descriptions using the {{< var validmind.developer >}}.[^7]
+
+:::
+
 {{< include _faq-explainability.qmd >}}
 
 {{< include _faq-synthetic-datasets.qmd >}}
@@ -62,4 +67,6 @@ Yes, {{< var vm.product >}} allows tests to be manipulated at several levels:
 
 [^5]: [`ClassImbalance()`](/validmind/validmind/tests/data_validation/ClassImbalance.html#ClassImbalance)
 
-[^6]: [Can I use my own tests?](/developer/model-testing/testing-overview.qmd#can-i-use-my-own-tests)
+[^6]: [Can I use my own tests?](/developer/model-testing/testing-overview.qmd#can-i-use-my-own-tests)
+
+[^7]: [Add context to LLM-generated test descriptions](/notebooks/how_to/add_context_to_llm_descriptions.ipynb)

site/guide/model-documentation/export-documentation.qmd

@@ -7,6 +7,11 @@ aliases:
 
 Export your model documentation or validation reports as Microsoft Word files (`.docx`) for use outside of the {{< var validmind.platform >}}.
 
+::: {.callout}
+{{< var vm.product >}} supports Word 365, Word 2019, Word 2016, and Word 2013.
+:::
+
+
 ::: {.attn}
 
 ## Prerequisites
@@ -16,10 +21,6 @@ Export your model documentation or validation reports as Microsoft Word files (`
 - [x] Model documentation is completed or in progress.[^2]
 - [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3]
 
-::: {.callout}
-{{< var vm.product >}} supports Word 365, Word 2019, Word 2016, and Word 2013.
-:::
-
 :::
 
 ## Export model documentation
@@ -32,30 +33,23 @@ Export your model documentation or validation reports as Microsoft Word files (`
 
 4. In right sidebar, click **{{< fa download >}} Export Document**.
 
-5. Configure the export options:
-
-   <!--- - Check **Include comment threads** to include comment threads in the exported file.
-   - Check **Section activity logs** to include a history of changes in each section of the documentation. --->
-   - Choose the file format for export. We currently support exporting to `.docx` for Microsoft Word format.
-
-6. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
+7. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
 
 ## Export validation report
 
 1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
 
 2. Select a model or find your model by applying a filter or searching for it.[^5]
 
-<!--- NR Mar 2024 this option does not yet exist --->
 3. In the left sidebar that appears for your model, click **{{< fa shield >}} Validation Report**.
 
 4. In right sidebar, click **{{< fa download >}} Export Document**.
 
-5. Configure the export options:
+5. Configure what is exported in your document by checking off the relevant boxes:
 
-   <!--- - Check **Include comment threads** to include comment threads in the exported file.
-   - Check **Section activity logs** to include a history of changes in each section of the documentation. --->
-   - Choose the file format for export. We currently support exporting to `.docx` for Microsoft Word format.
+   - Include compliance summary[^6]
+   - Include validation guidelines information[^7]
+   - Include validation guideline adherence details
 
 6. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
 
@@ -80,3 +74,6 @@ Export your model documentation or validation reports as Microsoft Word files (`
 
 [^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
 
+[^6]: [Assess compliance](/guide/model-validation/assess-compliance.qmd)
+
+[^7]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd)