validmind · validbeck · Mar 12, 2025 · Feb 5, 2025 · Feb 5, 2025 · Feb 5, 2025
diff --git a/.github/actions/setup-r/action.yml b/.github/actions/setup-r/action.yml
@@ -0,0 +1,33 @@
+name: "Setup R and install packages"
+description: "Sets up R and installs required packages for displaying interactive tables from .CSV"
+runs:
+  using: "composite"
+  steps:
+    - name: Set up R
+      uses: r-lib/actions/setup-r@v2
+      with:
+        r-version: '4.3'
+
+    - name: Cache R packages
+      uses: actions/cache@v3
+      with:
+        path: ${{ runner.os == 'Linux' && '/home/runner/work/_temp/Library' || runner.os == 'macOS' && '~/Library/R/4.3/library' }}
+        key: r-packages-${{ runner.os }}-${{ hashFiles('**/DESCRIPTION', '**/renv.lock') }}
+        restore-keys: |
+          r-packages-${{ runner.os }}-
+
+    - name: Install R packages
+      shell: bash
+      run: |
+        Rscript -e 'install.packages(c("DT", "readr", "stringr", "lubridate"), repos="https://cran.rstudio.com/")'
+
+    - name: Verify R installation
+      shell: bash
+      run: |
+        Rscript -e 'sessionInfo()'
+        which R
+
+    - name: Verify Quarto detects R
+      shell: bash
+      run: |
+        quarto check
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -8,8 +8,9 @@ PR instructions for release notes:
 - `internal` (skip Step 2, no release notes required)
 - `highlight`
 - `enhancement`
-- `bug`
+- `breaking-change`
 - `deprecation`
+- `bug`
 - `documentation`
 
 2. In the next section, describe the changes so that an external user can understand them. Keep it simple and link to the docs with [Learn more ...](<relative-link>), if available.

diff --git a/.github/workflows/deploy-docs-prod.yaml b/.github/workflows/deploy-docs-prod.yaml
@@ -25,6 +25,9 @@ jobs:
 
       - name: Fetch Quarto
         uses: ./.github/actions/fetch-quarto
+
+      - name: Setup R environment
+        uses: ./.github/actions/setup-r
 
       - name: Render prod docs site
         run: |

diff --git a/.github/workflows/deploy-docs-staging.yaml b/.github/workflows/deploy-docs-staging.yaml
@@ -25,6 +25,9 @@ jobs:
 
       - name: Fetch Quarto
         uses: ./.github/actions/fetch-quarto
+
+      - name: Setup R environment
+        uses: ./.github/actions/setup-r
 
       - name: Render staging docs site
         run: |

diff --git a/.github/workflows/validate-docs-site.yaml b/.github/workflows/validate-docs-site.yaml
@@ -25,6 +25,9 @@ jobs:
     - name: Fetch Quarto
       uses: ./.github/actions/fetch-quarto
 
+    - name: Setup R environment
+      uses: ./.github/actions/setup-r
+
     - name: Render demo docs site
       run: |
           cd site

diff --git a/README.md b/README.md
@@ -24,6 +24,12 @@ You need:
 - The Quarto extension for your IDE, such as [VS Code](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)
 - For Windows operating systems, install the `make` command via [Cygwin](https://cygwin.com/install.html)
 
+### Additional dependencies
+
+Some interactive tables, such as our breaking changes and dependency history rely you have R and some R packages installed in order for you to be able to preview or render certain pages of the docs site locally.
+
+**Refer to the [Breaking changes and deprecations](site/releases/breaking-changes/README.md) guide** for more information on how to install R and set up these tables.
+
 ## How to contribute
 
 > [!IMPORTANT]

diff --git a/release-scripts/generate-release-notes.ipynb b/release-scripts/generate-release-notes.ipynb
@@ -155,7 +155,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "label_hierarchy = [\"highlight\", \"enhancement\", \"deprecation\", \"bug\", \"documentation\"]\n",
+    "label_hierarchy = [\"highlight\", \"enhancement\", \"breaking-change\", \"deprecation\", \"bug\", \"documentation\"]\n",
     "gro.display_list(label_hierarchy)"
    ]
   },

diff --git a/release-scripts/generate_release_objects.py b/release-scripts/generate_release_objects.py
@@ -338,6 +338,7 @@ def setup_openai_api(env_location):
 label_to_category = {
     "highlight": "## Release highlights",
     "enhancement": "## Enhancements",
+    "breaking-change": "## Breaking changes",
     "deprecation": "## Deprecations",
     "bug": "## Bug fixes",
     "documentation": "## Documentation"
@@ -346,6 +347,7 @@ def setup_openai_api(env_location):
 categories = { 
     "highlight": [],
     "enhancement": [],
+    "breaking-change": [],
     "deprecation": [],
     "bug": [],
     "documentation": []
@@ -899,7 +901,7 @@ def main():
         setup_openai_api(env_location)
         print()
 
-        label_hierarchy = ["highlight", "enhancement", "deprecation", "bug", "documentation"]
+        label_hierarchy = ["highlight", "enhancement", "breaking-change", "deprecation", "bug", "documentation"]
         display_list(label_hierarchy)
         print()
 

diff --git a/site/Makefile b/site/Makefile
@@ -90,6 +90,11 @@ docs-site: get-source
 	quarto render --profile production
 	@$(MAKE) execute PROFILE=exe-prod
 
+# Get all source files
+docs-site-lite: get-source
+	@echo "\nRendering the static HTML site ..."
+	quarto render --profile production
+
 # Deployment to https://docs-demo.vm.validmind.ai/
 deploy-demo:
 	@if [ "`git rev-parse --abbrev-ref HEAD`" != "docs-demo" ]; then \
@@ -152,7 +157,7 @@ yearly-releases:
 execute:
 	quarto render --profile $(PROFILE) $(FILE_PATH)
 
-docker-build: docs-site
+docker-build: docs-site-lite
 	@echo "\nBuilding the Docker image ..."
 	@docker build -f ../Dockerfile -t validmind-docs ..
 

diff --git a/site/_quarto.yml b/site/_quarto.yml
@@ -2,6 +2,9 @@ project:
   type: website
   post-render: make python-docs
 
+metadata-files:
+  - training/_sidebar.yaml
+
 website:
   announcement: 
     content: "[**{{< fa book-open-reader >}} EU AI Act Compliance**](https://validmind.com/download-whitepaper-the-eu-ai-act/) — Read our original regulation brief on how the EU AI Act aims to balance innovation with safety and accountability, setting standards for responsible AI use" 
@@ -170,6 +173,7 @@ website:
         - text: "---"
         - text: "Releases"
         # MAKE-RELEASE-NOTES-EMBED-MARKER
+        - releases/2025/2025-mar-07/release-notes.qmd
         - releases/2025/2025-jan-31/release-notes.qmd
         # CURRENT-YEAR-END-MARKER
         - file: releases/2024/2024-releases.qmd
@@ -197,6 +201,8 @@ website:
           - releases/2023/release-notes-2023-jul-24.qmd
           - releases/2023/release-notes-2023-jun-22.qmd
           - releases/2023/release-notes-2023-may-30.qmd
+        - text: "Breaking changes & deprecations"
+          file: releases/breaking-changes/breaking-changes.qmd
         - text: "---"
         - text: "Fine Print"
         - about/fine-print/data-privacy-policy.qmd

diff --git a/site/about/fine-print/data-privacy-policy.qmd b/site/about/fine-print/data-privacy-policy.qmd
@@ -37,9 +37,9 @@ Service Organization Control 2 (SOC 2) is a type of audit report that evaluates
 
 The {{< var validmind.platform >}} is a secure, multi-tenant solution that can be hosted on Amazon Web Services (AWS), Microsoft Azure Cloud (Azure), or Google Cloud Platform (GCP). For organizations that require a stricter trust model and the highest level of security, such as financial services organizations handling highly sensitive data, {{< var vm.product >}} also offers a _{{< var validmind.vpv >}} (VPV)_ option to host our solution in a dedicated single-tenant cloud instance.
 
-The {{< var validmind.vpv >}} option provides all the features and services of other editions of our products, but hosted within a separate environment that is isolated from other {{< var vm.product >}} accounts. VPV accounts do not share resources with non-VPV accounts.
+The {{< var validmind.vpv >}} option provides all our features and services but hosted within a separate environment that is isolated from other {{< var vm.product >}} accounts. VPV accounts do not share resources with non-VPV accounts.
 
-Access to any edition is available through AWS PrivateLink, Azure Private Link, or GCP Private Service Connect, all of which provide private connectivity between {{< var vm.product >}} and your on-premises network without exposing your traffic to the public internet. 
+Access is available through AWS PrivateLink, Azure Private Link, or GCP Private Service Connect, all of which provide private connectivity between {{< var vm.product >}} and your on-premises network without exposing your traffic to the public internet. 
 
 ## What model artifacts are imported into documentation?
 
@@ -56,5 +56,4 @@ The {{< var validmind.developer >}} does not send any personally identifiable in
 
 <!-- ## What's next
 
-- [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd) -->
-<!--- [Editions and features](editions-and-features.qmd) --->
+- [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd) -->
diff --git a/site/developer/model-testing/testing-overview.qmd b/site/developer/model-testing/testing-overview.qmd
@@ -6,6 +6,7 @@ aliases:
 listing:
   - id: tests-beginner
     type: grid
+    grid-columns: 2
     max-description-length: 250
     sort: false
     fields: [title, description]
@@ -28,7 +29,7 @@ listing:
     max-description-length: 250
     sort: false
     fields: [title, description]
-    contents: 
+    contents:
     - ../../notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
     - ../../notebooks/how_to/configure_dataset_features.ipynb
     - ../../notebooks/how_to/run_documentation_sections.ipynb
@@ -43,6 +44,7 @@ listing:
     contents: 
     - ../../notebooks/how_to/document_multiple_results_for_the_same_test.ipynb
     - ../../notebooks/how_to/load_datasets_predictions.ipynb
+    - ../../notebooks/how_to/understand_utilize_rawdata.ipynb
   - id: tests-custom
     type: grid
     max-description-length: 250

diff --git a/site/faq/_faq-editions.qmd b/site/faq/_faq-editions.qmd
diff --git a/site/faq/faq-organizations.qmd b/site/faq/faq-organizations.qmd
@@ -13,8 +13,6 @@ listing:
     - ../guide/configuration/managing-users.qmd
 ---
 
-{{< include _faq-editions.qmd >}}
-
 ## How do I get access to {{< var vm.product >}}?
 
 #### 1. Register with ValidMind
@@ -40,7 +38,7 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^5] has sufficien
 
 - {{< var vm.product >}} provides a built-in user management interface that allows new users to be registered on the {{< var validmind.platform >}} and assigned user roles[^6] and user groups.[^7]
 - User roles, user groups, and access permissions are configured during initial onboarding and can be updated at any time.
-- In addition, {{< var vm.product >}} also provides support for Single Sign-On (SSO) integration as part of our Enterprise and our {{< var validmind.vpv >}} (VPV) edition.
+- In addition, {{< var vm.product >}} also offers support for Single Sign-On (SSO) integration.
 
 ## How do user roles, user groups, and access permissions work? 
 

diff --git a/site/faq/faq-privacy.qmd b/site/faq/faq-privacy.qmd
@@ -18,11 +18,15 @@ listing:
     - ../guide/model-inventory/view-model-activity.qmd
 ---
 
-{{< include _faq-editions.qmd >}}
+## How does {{< var vm.product >}} handle the processing of PII?
+
+{{< var vm.product >}} does not send any personally identifiable information (PII) through our {{< var validmind.api >}}.[^1]
+
+Access to the {{< var validmind.platform >}} is facilitated through AWS PrivateLink, which provides private connectivity between {{< var vm.product >}} and your on-premises networks without exposing your traffic to the public internet.[^2]
 
 ## What model artifacts are automatically imported into {{< var vm.product >}}?
 
-{{< var vm.product >}} stores the following artifacts in the documentation via our {{< var validmind.api >}}:[^1]
+{{< var vm.product >}} stores the following artifacts in the documentation via our {{< var validmind.api >}}:
 
 - Dataset and model metadata which allow generating documentation snippets programmatically (example: stored definition for "common logistic regression limitations" when a logistic regression model has been passed to the {{< var vm.product >}} test suite execution)
 - Quality and performance metrics collected from the dataset and model
@@ -35,7 +39,7 @@ listing:
 - With multi-tenant deployments, infrastructure is shared but with strict data isolation protocols that ensure that no tenant can access another's sensitive information. 
 
 ::: {.callout}
-## For organizations requiring the highest degree of data security, {{< var vm.product >}} offers a {{< var validmind.vpv >}} (VPV) option to host the solution in a dedicated single-tenant cloud instance on the {{< var vm.product >}} cloud account. 
+## For organizations requiring the highest degree of data security, {{< var vm.product >}} offers a {{< var validmind.vpv >}} (VPV)[^3] option to host the solution in a dedicated single-tenant cloud instance on the {{< var vm.product >}} cloud account. 
 
 Furthermore, {{< var vm.product >}}'s data retention policy complies with the SOC 2 security standard.
 :::
@@ -82,4 +86,8 @@ Additionally, {{< var vm.product >}} is developing a feature that enables develo
 
 <!-- FOOTNOTES -->
 
-[^1]: [{{< var validmind.developer >}}](/validmind/validmind.html)
+[^1]: [{{< var validmind.developer >}}](/validmind/validmind.html)
+
+[^2]: [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd)
+
+[^3]: [{{< var validmind.vpv >}} (VPV)](/about/deployment/virtual-private-validmind.qmd)
diff --git a/site/faq/faq-testing.qmd b/site/faq/faq-testing.qmd
@@ -37,10 +37,10 @@ Yes, {{< var vm.product >}} allows tests to be manipulated at several levels:
 - You can configure which tests are required to run programmatically depending on the model use case.[^4]
 - 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]
+- Personalize tests further for your use case by using {{< var vm.product >}}'s `RawData` feature[^7] to customize the output of tests.
 
 ::: {.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]
-
+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 >}}.[^8]
 :::
 
 {{< include _faq-explainability.qmd >}}
@@ -69,4 +69,6 @@ In addition to custom tests, you can also add use case and test-specific context
 
 [^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)
+[^7]: [Understand and utilize `RawData` in {{< var vm.product >}} tests](/notebooks/how_to/understand_utilize_rawdata.ipynb)
+
+[^8]: [Add context to LLM-generated test descriptions](/notebooks/how_to/add_context_to_llm_descriptions.ipynb)
diff --git a/site/faq/faq.qmd b/site/faq/faq.qmd
@@ -12,7 +12,7 @@ listing:
     contents:
     - path: faq-organizations.qmd
       title: "Access and permissions"
-      categories: ["editions", "access", "permissions", "organizations", "user registration", "validmind platform"]
+      categories: ["access", "permissions", "organizations", "user registration", "validmind platform"]
     - path: faq-workflows.qmd
       title: "Model workflows"
       categories: ["workflows", "model lifecycle", "lifecycle statuses", "validmind platform", "validmind library"]
@@ -39,7 +39,7 @@ listing:
       categories: ["supported libraries", "supported languages", "integrations", "images", "large language models", "explainability", "deployment options", "validmind library"]
     - path: faq-privacy.qmd
       title: "Data handling and privacy"
-      categories: ["editions", "data handling", "privacy", "confidentiality", "model activity", "auditing", "validmind platform", "validmind library"]
+      categories: ["data handling", "privacy", "confidentiality", "model activity", "auditing", "validmind platform", "validmind library"]
 ---
 
 ## Answers by topic

diff --git a/site/guide/guides.qmd b/site/guide/guides.qmd
@@ -145,34 +145,13 @@ Then, work with documentation and customizable templates, and collaborate with m
 :::{#guides-model-documentation}
 :::
 
-::: {.grid}
-::: {.g-col-8}
-{{< video https://www.youtube.com/embed/videoseries?si=aP7yLOGO60h4vi8C&amp;list=PL7I7ZrCoVCCP876aLRCjitZqYif96Whlz title='Developer Fundamentals' >}}
-
-::: {.video-cap .tc}
-(10 videos)
-:::
-
-:::
-:::
-
 ## Model validation
 
 Set up validation guidelines and prepare validation reports, work with findings and evidence, and collaborate with model developers within the {{< var vm.platform >}}:
 
 :::{#guides-model-validation}
 :::
 
-::: {.grid}
-::: {.g-col-8}
-{{< video https://www.youtube.com/embed/videoseries?si=JfBNClmsZYLS7m9F&amp;list=PL7I7ZrCoVCCObEiuLLAL0Wm9GQ6x5U0q5 title='Validating Models 101' >}}
-
-::: {.video-cap .tc}
-(5 videos)
-::: 
-
-:::
-:::
 
 Review reports or export your documentation for external records:
 

diff --git a/site/guide/model-documentation/work-with-content-blocks.qmd b/site/guide/model-documentation/work-with-content-blocks.qmd
@@ -149,7 +149,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block
 
 <!-- FOOTNOTES -->
 
-[^1]: [Add mathematical formuals](#add-mathematical-formulas)
+[^1]: [Add mathematical formulas](#add-mathematical-formulas)
 
 [^2]: [Collaborate with others](collaborate-with-others.qmd)
 
@@ -169,4 +169,4 @@ Test-driven or metric over time blocks can be re-added later on but **text block
 
 [^10]: [View model activity](/guide/model-inventory/view-model-activity.qmd)
 
-[^11]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
+[^11]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
diff --git a/site/index.qmd b/site/index.qmd
@@ -46,12 +46,12 @@ listing:
     fields: [title, description]
     contents:
     # MAKE-RELEASE-NOTES-LATEST-MARKER
+      - /releases/2025/2025-mar-07/release-notes.qmd
       - /releases/2025/2025-jan-31/release-notes.qmd
       - /releases/2024/2024-dec-24/release-notes.qmd
       - /releases/2024/2024-dec-06/release-notes.qmd
       - /releases/2024/2024-oct-22/release-notes.qmd
       - /releases/2024/2024-sep-25/release-notes.qmd
-      - /releases/2024/2024-sep-09/release-notes.qmd
     # MAKE-RELEASE-NOTES-OLDEST-MARKER
   - id: validmind-academy
     type: grid

diff --git a/site/notebooks.zip b/site/notebooks.zip