Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,17 @@ release-scripts/__pycache__
site/installation

# Release notes source tracked in private repository
site/releases
# Release notes source tracked in private repository
site/releases/**
!site/releases/all-releases.qmd
!site/releases/_how-to-upgrade.qmd
!site/releases/_sidebar.yaml
!site/releases/2023
!site/releases/2024
!site/releases/2025
!site/releases/2023/
!site/releases/2023/**
!site/releases/2024/
!site/releases/2024/**
!site/releases/2025/
!site/releases/2025/**

# Generated ConfigMap for Docker profile
site/validmind-docs.yaml
Expand Down
4 changes: 2 additions & 2 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ website:
</ul>
<ul class="footer-user-guides-column-2">
<li><a href="/guide/guides.qmd#documents-templates">Documents & templates</a></li>
<li><a href="/guide/guides.qmd#model-documentation">Documentation</a></li>
<li><a href="/guide/guides.qmd#model-validation">Validation</a></li>
<li><a href="/guide/guides.qmd#documentation">Documentation</a></li>
<li><a href="/guide/guides.qmd#validation">Validation</a></li>
<li><a href="/guide/guides.qmd#reporting">Reporting</a></li>
<li><a href="/guide/guides.qmd#monitoring">Monitoring</a></li>
<li><a href="/guide/guides.qmd#attestation">Attestation</a></li>
Expand Down
4 changes: 2 additions & 2 deletions site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o

```markdown
<!-- IN THE BODY OF YOUR CONTENT -->
- The model is registered in the model inventory.[^1]
- The record is registered in the inventory.[^1]
- You've already customized your model lifecycle statuses for use in workflows.[^2]
- Workflows have already been set up for use with your models.[^3]
- You are assigned a role that has access to complete actions set up by workflows.[^5]
Expand All @@ -175,7 +175,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o
<!-- FOOTNOTES -->
[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^2]: [Manage model stages](manage-model-stages.qmd)
[^2]: [Manage record stages](manage-record-stages.qmd)

[^3]: [Configure workflows](configure-workflows.qmd)

Expand Down
2 changes: 1 addition & 1 deletion site/about/contributing/using-the-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Step-by-step instructions for platform tasks, organized by feature area.
| [Integrations](/guide/integrations/managing-integrations.qmd) | Connecting {{< var vm.product >}} to external systems | Manage secrets, configure connections, link external models |
| [Workflows](/guide/guides.qmd#workflows) | Automating model lifecycle processes | Configure workflow steps, manage transitions, set up approvals |
| [Inventory](/guide/guides.qmd#inventory) | Managing your model and record inventory | Register records, edit fields, configure interdependencies |
| [Documents & templates](/guide/templates/working-with-model-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library |
| [Documents & templates](/guide/templates/working-with-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library |
| [Model documentation](/guide/guides.qmd#model-documentation) | Authoring and collaborating on model docs | Edit content blocks, add test results, manage versions, submit for approval |
| [Model validation](/guide/guides.qmd#model-validation) | Reviewing and validating models | Review documentation, assess compliance, manage findings and artifacts |
| [Reporting](/guide/guides.qmd#reporting) | Analyzing and exporting data | View reports, create custom analytics, export inventory and documents |
Expand Down
2 changes: 1 addition & 1 deletion site/about/glossary/_model-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
1. Create a new file under the `about/glossary/model_documentation` folder with the following structure `_doc-feature.qmd` (the `_` is mandatory for Quarto to retrieve the file as a single-source embed: https://quarto.org/docs/authoring/includes.html)
2. Embed it below in ABC order with the structure `{{< include model_documentation/_doc-feature.qmd >}}`

These instructions update the documentation concept on `working-with-model-documentation.qmd` as well as the glossary.
These instructions update the documentation concept on `working-with-documentation.qmd` as well as the glossary.

-->

Expand Down
2 changes: 1 addition & 1 deletion site/about/glossary/_validmind-features.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ client library, Python client library
: Enables the interaction of your development environment with the {{< var validmind.platform >}} as part of the {{< var validmind.developer >}}.

content block
: Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, ongoing monitoring reports, and custom document types.^[[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd)]
: Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, ongoing monitoring reports, and custom document types.^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd)]

documentation automation
: A core benefit of {{< var vm.product >}} that allows for the automatic creation of model documentation using predefined templates and test suites.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

conceptual soundness
: Establishes the foundation of the model, covering the model overview, intended use and business use case, regulatory requirements, model limitations, and the rationale behind the model selection. It emphasizes the model’s purpose, scope, and constraints, which are crucial for stakeholders to understand the model’s applicability and limitations.
: Establishes the foundation of a selected record such as a model, covering the overview, intended use and business use case, regulatory requirements, limitations, and the rationale behind selection. It emphasizes purpose, scope, and constraints, which are crucial for stakeholders to understand applicability and limitations.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

data preparation
: Details the data description, including dataset summary, data quality tests, descriptive statistics, correlations and interactions, and feature selection and engineering. It provides transparency into the data used for model training, ensuring that the model is built on a solid and relevant dataset.
: Details the data description, including dataset summary, data quality tests, descriptive statistics, correlations and interactions, and feature selection and engineering. It provides transparency into the data used for training, ensuring that the record such as a model is built on a solid and relevant dataset.
4 changes: 3 additions & 1 deletion site/about/glossary/model_documentation/_doc-intro.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

Each section of your model documentation should address critical aspects of the model’s lifecycle, from conceptualization and data preparation through development and ongoing management. This comprehensive documentation approach is essential for ensuring the model’s reliability, relevance, and compliance with business and regulatory standards.
Each section of your development documentation should address critical aspects of the record’s lifecycle, from conceptualization and data preparation through development and ongoing management. This comprehensive documentation approach is essential for ensuring the record’s reliability, relevance, and compliance with business and regulatory standards.

For example, documentation for models typically include sections on:
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

model development
: Discusses the model training, evaluation, explainability, interpretability, and diagnosis, including model weak spots, overfit regions, and robustness. This section is vital for understanding how the model was developed, how it performs, and its areas of strength and weakness.
model development, development
: Discusses the training, evaluation, explainability, interpretability, and diagnosis, including weak spots, overfit regions, and robustness. This section is vital for understanding how the record such as a model was developed, how it performs, and its areas of strength and weakness.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

monitoring and governance
: Focuses on the model’s ongoing monitoring plan, implementation, and governance plan. It outlines strategies for maintaining the model’s performance over time and ensuring that it remains compliant with regulatory requirements and ethical standards.
: Focuses on the record such as a model’s ongoing monitoring plan, implementation, and governance plan. It outlines strategies for maintaining the performance over time and ensuring that it remains compliant with regulatory requirements and ethical standards.
2 changes: 1 addition & 1 deletion site/about/glossary/monitoring/_ongoing-monitoring.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

ongoing monitoring
: A periodic report assessing the model's performance and compliance over time, ensuring it remains valid under changing conditions.
: A periodic report assessing the tool such as a model's performance and compliance over time, ensuring it remains valid under changing conditions.
2 changes: 1 addition & 1 deletion site/about/glossary/validation_reports/_actions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

actions
: Recommended steps or measures to address artifacts from model validation or risk assessments.
: Recommended steps or measures to address artifacts from validation or risk assessments.
2 changes: 1 addition & 1 deletion site/about/glossary/validation_reports/_artifacts.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

artifacts (previously findings)
: Observations or issues identified during model validation, including any deviations from expected performance or standards. Artifacts are organized by type — default types include Validation Issue, Policy Exception, and Model Limitation. Custom artifact types such as Change Management Record can be created to track other categories relevant to your organization.
: Observations or issues identified during validation, including any deviations from expected performance or standards. Artifacts are organized by type — default types include Validation Issue, Policy Exception, and Limitation. Custom artifact types such as Change Management Record can be created to track other categories relevant to your organization.
2 changes: 1 addition & 1 deletion site/about/glossary/validation_reports/_evidence.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

evidence
: Material provided by the developer and reviewed by the validator, such as model documentation, source code, datasets, monitoring reports or previous validation reports.
: Material provided by the developer and reviewed by the validator, such as documentation, source code, datasets, monitoring reports or previous validation reports.
2 changes: 1 addition & 1 deletion site/about/glossary/validation_reports/_report-intro.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

A validation report is a comprehensive review that evaluates a model's accuracy, performance, and suitability for its intended purpose. It encompasses the process of model risk assessment, identifying areas of potential error or risk within the model's components, such as data inputs and algorithms. The report follows established validation guidelines to ensure consistency and adherence to internal and regulatory standards.
A validation report is a comprehensive review that evaluates a record's accuracy, performance, and suitability for its intended purpose. It encompasses the process of risk assessment, identifying areas of potential error or risk within the record's components, such as data inputs and algorithms. The report follows established validation guidelines to ensure consistency and adherence to internal and regulatory standards.
12 changes: 6 additions & 6 deletions site/about/glossary/validation_reports/_review.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

review
: Entails a comprehensive evaluation process covering four key aspects of model documentation to ensure thoroughness, compliance, and reliability:
: Entails a comprehensive evaluation process covering four key aspects of documentation to ensure thoroughness, compliance, and reliability:

- **Conceptual soundness** — Examines the foundational elements of the model, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the model's purpose, scope, and constraints are well-defined and understood by stakeholders.
- **Conceptual soundness** — Examines the foundational elements of the record, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the record's purpose, scope, and constraints are well-defined and understood by stakeholders.

- **Data preparation** — Assesses the quality and preparation of the data used for model training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the model is built on a robust and relevant dataset.
- **Data preparation** — Assesses the quality and preparation of the data used for record training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the record is built on a robust and relevant dataset.

- **Model development** — Focuses on the model's development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the model’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically.
- **Development** — Focuses on the record's development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the record’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically.

- **Monitoring and governance** — Evaluates the ongoing strategies for monitoring the model's performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the model's efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the model's documented results.
- **Monitoring and governance** — Evaluates the ongoing strategies for monitoring the record's performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the record's efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the record's documented results.

These elements collectively ensure that the model documentation is thorough, transparent, and meets all necessary standards and regulatory requirements.
These elements collectively ensure that the documentation is thorough, transparent, and meets all necessary standards and regulatory requirements.
4 changes: 2 additions & 2 deletions site/about/glossary/validation_reports/_risk-areas.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

model risk areas
: Specific components or aspects of a model where risk might be present, such as data inputs, algorithms, or implementation.
model risk areas, risk areas
: Specific components or aspects of a record such as a model where risk might be present, such as data inputs, algorithms, or implementation.
4 changes: 2 additions & 2 deletions site/about/glossary/validation_reports/_risk-assessment.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

model risk assessment
: The process of identifying and evaluating risks associated with the use and potential errors in a financial model.
model risk assessment, risk assessment
: The process of identifying and evaluating risks associated with the use and potential errors in a record such as a model.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

validation guidelines
: Established standards or procedures for conducting thorough and consistent model validations, usually aligned with principles within specific models or AI risk frameworks.
: Established standards or procedures for conducting thorough and consistent validations, usually aligned with principles within specific tools such as models or AI risk frameworks.
2 changes: 1 addition & 1 deletion site/about/overview-model-risk-management.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ By integrating these features, {{< var vm.product >}} provides a comprehensive s

[^1]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)

[^2]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)
[^2]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)

[^3]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd)

Expand Down
8 changes: 4 additions & 4 deletions site/about/use-cases/e-23.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -141,22 +141,22 @@ Use this checklist to track your E-23 implementation progress:

[^4]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^5]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)
[^5]: [Working with documentation](/guide/documentation/working-with-documentation.qmd)

[^6]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd)

[^7]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)
[^7]: [Working with documentation](/guide/documentation/working-with-documentation.qmd)

[^8]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

[^9]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^10]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)
[^10]: [Working with documentation](/guide/documentation/working-with-documentation.qmd)

[^11]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

[^12]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd)

[^13]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)

[^14]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd)
[^14]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd)
Loading
Loading