validmind · nrichers · Aug 19, 2023 · Jul 20, 2023 · Jul 20, 2023 · Jul 26, 2023
diff --git a/site-unused/architecture.qmd b/site-unused/architecture.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Architecture"
-keywords: "architecture, model risk management, ValidMind"
+keywords: "architecture, ai risk, model risk management, ValidMind"
 ---
 
 ## Brief Introduction

diff --git a/site-unused/assign-model-validators.qmd b/site-unused/assign-model-validators.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Assign model validators"
-keywords: "assign model validators, model risk management, ValidMind"
+keywords: "assign model validators, ai risk, model risk management, ValidMind"
 ---
 
 [Include a brief description of what this task is about, why it's important, and who it's intended for.]
@@ -25,7 +25,7 @@ keywords: "assign model validators, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/cloud-platforms.qmd b/site-unused/cloud-platforms.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Cloud platforms"
-keywords: "cloud platforms, model risk management, ValidMind"
+keywords: "cloud platforms, ai risk, model risk management, ValidMind"
 ---
 
 ## Brief Introduction

diff --git a/site-unused/configure-sso.qmd b/site-unused/configure-sso.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Configure Single Sign-On (SSO)"
-keywords: "configure single sign-on (SSO), model risk management, ValidMind"
+keywords: "configure single sign-on (SSO), ai risk, model risk management, ValidMind"
 ---
 
 [Include a brief description of what this task is about, why it's important, and who it's intended for.]
@@ -25,7 +25,7 @@ keywords: "configure single sign-on (SSO), model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/configure-test-plans.qmd b/site-unused/configure-test-plans.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Configure test plans"
-keywords: "configure test plans, model risk management, ValidMind"
+keywords: "configure test plans, ai risk, model risk management, ValidMind"
 ---
 
 [Include a brief description of what this task is about, why it's important, and who it's intended for.]
@@ -25,7 +25,7 @@ keywords: "configure test plans, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/configure-workflows.qmd b/site-unused/configure-workflows.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Configure workflows"
-keywords: "configure workflows, administrator, model risk management, ValidMind"
+keywords: "configure workflows, administrator, ai risk, model risk management, ValidMind"
 ---
 
 As part of the initial setup of the ValidMind solution for your company or organization, you need to configure the validation workflows that users such as model developers and model validators will follow. 
@@ -25,7 +25,7 @@ As part of the initial setup of the ValidMind solution for your company or organ
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/create-project-findings.qmd b/site-unused/create-project-findings.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Create project findings"
-keywords: "create project findings, model risk management, ValidMind"
+keywords: "create project findings, ai risk, model risk management, ValidMind"
 ---
 
 [Include a brief description of what this task is about, why it's important, and who it's intended for.]
@@ -25,7 +25,7 @@ keywords: "create project findings, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/dataset-object.qmd b/site-unused/dataset-object.qmd
@@ -1,6 +1,6 @@
 ---
 title: "The dataset object"
-keywords: "dataset object, model risk management, ValidMind"
+keywords: "dataset object, ai risk, model risk management, ValidMind"
 ---
 
 ## Brief Introduction

diff --git a/site-unused/edit-templates.qmd b/site-unused/edit-templates.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Configure templates"
-keywords: "configure templates, administrator, model risk management, ValidMind"
+keywords: "configure templates, administrator, ai risk, model risk management, ValidMind"
 ---
 
 As part of the initial setup of the ValidMind solution for your company or organization, you need to configure what templates are available to your users. Templates are a way to configure required validation tests and standardize the documentation table of contents for specific model use cases.
@@ -25,7 +25,7 @@ As part of the initial setup of the ValidMind solution for your company or organ
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/explore-validmind.qmd b/site-unused/explore-validmind.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Explore ValidMind"
-keywords: "explore, model risk management, ValidMind"
+keywords: "explore, ai risk, model risk management, ValidMind"
 ---
 
 ## Access the sample Jupyter notebook 

diff --git a/site-unused/glossary.qmd b/site-unused/glossary.qmd
diff --git a/site-unused/manage-project-findings.qmd b/site-unused/manage-project-findings.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Manage project findings"
-keywords: "manage project findings, model risk management, ValidMind"
+keywords: "manage project findings, ai risk, model risk management, ValidMind"
 ---
 
 [Include a brief description of what this task is about, why it's important, and who it's intended for.]
@@ -25,7 +25,7 @@ keywords: "manage project findings, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
diff --git a/site-unused/manage-users-and-roles.qmd b/site-unused/manage-users-and-roles.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Manage users and roles"
-keywords: "manage users, manage roles, model risk management, ValidMind"
+keywords: "manage users, manage roles, ai risk, model risk management, ValidMind"
 ---
 
 [Include a brief description of what this task is about, why it's important, and who it's intended for.]
@@ -27,7 +27,7 @@ keywords: "manage users, manage roles, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-### What's Next
+### What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
@@ -49,7 +49,7 @@ keywords: "manage users, manage roles, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-### What's Next
+### What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 
@@ -71,7 +71,7 @@ keywords: "manage users, manage roles, model risk management, ValidMind"
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-### What's Next
+### What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 

diff --git a/site-unused/mermaid-diagrams-dev-framework.qmd b/site-unused/mermaid-diagrams-dev-framework.qmd
@@ -0,0 +1,43 @@
+### In your modeling environment
+
+```{mermaid}
+graph TD
+    A[Build the model] --> B[Export datasets and models]
+    B --> C[In your documentation environment:<br>Load training datasets and models]
+```
+
+### In your documentation environment
+
+```{mermaid}
+graph TD
+    A[Create notebook<br>to select and<br>build relevant tests] --> B[From your modeling<br>environment,<br>load trained datasets<br>and models.]
+    B --> C[Initialize developer framework.]
+    C --> D[Select relevant tests.]
+    D --> E{Check if all<br>tests covered by<br>ValidMind or<br>custom test<br>provider?}
+    E -- Yes --> F[Run selected tests]
+    F --> G[Review test results]
+    E -- No --> H[Create and register additional tests]
+    G --> I[ValidMind Platform UI:<br>Add content blocks to model documentation]
+    H --> E
+```
+
+### In ValidMind Platform UI
+
+```{mermaid}
+graph TB
+    A[Register new model] --> B[Select documentation template]
+    B --> C[Review template structure]
+    C --> D[View framework integration instructions]
+    D --> E[Add content blocks to model documentation:]
+    E --> F[Select the block type:]
+    F --> G[Test-driven block: Select from available test provider results]
+    F --> H[Text block:]
+    H --> I{New or existing block?:}
+    I --> J[New]
+    J --> K[Add new editable text content block]
+    K --> L[Review and collaborate]
+    I --> M[Existing: Select from available texts from content provider]
+    L --> N[Submit for review]
+    M --> N
+    G --> N
+```
diff --git a/site-unused/model-evaluation-tests.qmd b/site-unused/model-evaluation-tests.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Model evaluation tests"
-keywords: "model evaluation tests, model risk management, ValidMind"
+keywords: "model evaluation tests, ai risk, model risk management, ValidMind"
 ---
 
 This article provides an examples of how to run model evaluation test plans, and provides a reference to other model evaluation tests and test plans available in the Developer Framework. 

diff --git a/site-unused/model-object.qmd b/site-unused/model-object.qmd
@@ -1,6 +1,6 @@
 ---
 title: "The model object"
-keywords: "model object, model risk management, ValidMind"
+keywords: "model object, ai risk, model risk management, ValidMind"
 ---
 
 ## Brief Introduction

diff --git a/site-unused/mrm-lifecyle.qmd b/site-unused/mrm-lifecyle.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Model lifecycle and workflow "
-keywords: "model lifecycle, workflow, model risk management, ValidMind"
+keywords: "model lifecycle, workflow, ai risk, model risk management, ValidMind"
 ---
 
 Model Risk Management (MRM) plays an important role in ensuring the accuracy, reliability, and effectiveness of models used in decision-making processes. This article focuses on the model lifecycle and process workflow, outlining the key stages and activities that constitute a robust MRM framework.

diff --git a/site-unused/mrm-three-lines-of-defense.qmd b/site-unused/mrm-three-lines-of-defense.qmd
@@ -1,6 +1,6 @@
 ---
 title: "The three line of defense"
-keywords: "three lines of defense, model risk management, ValidMind"
+keywords: "three lines of defense, ai risk, model risk management, ValidMind"
 ---
 
 Model Risk Management (MRM) is a crucial process for organizations using mathematical and statistical models to inform decision-making. MRM aims to identify, assess, and mitigate risks arising from model usage, ensuring the accuracy and reliability of model outputs. A key aspect of MRM is its three lines of defense, which provide a structured approach to managing model risk across various functions and roles.

diff --git a/site-unused/mrm.qmd b/site-unused/mrm.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Model risk management"
-keywords: "MRM, model risk management, ValidMind"
+keywords: "MRM, ai risk, model risk management, ValidMind"
 ---
 
 Model risk management (MRM) is a process for organizations using mathematical and statistical models to inform decision-making. MRM aims to identify, assess, and mitigate risks arising from model usage, ensuring the accuracy and reliability of model outputs.

diff --git a/site-unused/release-access.qmd b/site-unused/release-access.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Release access"
-keywords: "release access, model risk management, ValidMind"
+keywords: "release access, ai risk, model risk management, ValidMind"
 ---
 
 Welcome to the {{< var version >}} for ValidMind. On this page you will find important information to help you get access.

diff --git a/site-unused/release-notes.qmd b/site-unused/release-notes.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Release notes"
-keywords: "release notes, model risk management, ValidMind"
+keywords: "release notes, ai risk, model risk management, ValidMind"
 ---
 
 ## Release highlights

diff --git a/site-unused/run-tests-test-plans-test-suites.qmd b/site-unused/run-tests-test-plans-test-suites.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Run test plans"
-keywords: "run test plans, model risk management, ValidMind"
+keywords: "run test plans, ai risk, model risk management, ValidMind"
 ---
 
 Learn how you use ValidMind to run tests, test plans, and test suites. This topic is relevant for model developers who want to adopt the testing functionality that is available in the ValidMind Developer Framework.
@@ -10,7 +10,7 @@ Learn how you use ValidMind to run tests, test plans, and test suites. This topi
 
 [Include any common issues or errors that may arise during the task and how to resolve them.]
 
-## What's Next
+## What's next
 
 [Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
 --->

diff --git a/site-unused/tabular-data-tests.qmd b/site-unused/tabular-data-tests.qmd
@@ -1,6 +1,6 @@
 ---
 title: "Tabular data tests"
-keywords: "tabular data tests, model risk management, ValidMind"
+keywords: "tabular data tests, ai risk, model risk management, ValidMind"
 ---
 
 This article provides an example of how to run a Test Plan to validate a tabular dataset, and provides a reference to other dataset tests and test plans available in the Developer Framework. 

diff --git a/site-unused/track-model-lifecycle.qmd b/site-unused/track-model-lifecycle.qmd
@@ -0,0 +1,33 @@
+---
+title: "Tracking the model lifecycle"
+keywords: "track model lifecycle, ai risk, model risk management, ValidMind"
+---
+
+A typical high-level model lifecycle workflow looks like this:
+
+```{mermaid}
+graph LR
+    A[New model<br>registration] --> B[Initial<br>validation]
+    B --> C[Validation<br>approval]
+    C --> D[In production]
+    D --> E[Periodic review<br>and revalidation]
+    E --> B
+```
+<br>
+
+New model registration
+: Model owners and validators use the model inventory to manage all metadata associated with a model, including compliance and regulatory attributes. Users select a documentation template when registering a new inventory model.
+
+**Initial validation**
+: Triggers a new documentation workflow, resulting in a model that is ready for production deployment after its documentation and validation reports are approved. 
+
+See [Track the documentation workflow](#tracking-the-documentation-workflow) for more details.
+
+**Validation approval**
+: Perform validation of the model to ascertain that it meets the needs for which it was designed. ValidMind can connect to third-party systems to send events when a model has been approved for production.
+
+**In production**
+: Use the model in production while ensuring its ongoing reliability, accuracy, and compliance with regulations by monitoring the model's performance.
+
+**Periodic review and revalidation**
+: As part of regular performance monitoring or change management, developers and validators follow a process similar to that seen in the **Initial validation** step.
diff --git a/site/Makefile b/site/Makefile
@@ -75,12 +75,7 @@ docs-site: clean clone notebooks python-docs
 
 # Deployment to https://docs-demo.vm.validmind.ai/
 deploy-demo:
-	@if [ "`git rev-parse --abbrev-ref HEAD`" != "docs-demo" ]; then \
-		echo "You're not on the docs-demo branch, no action taken."; \
-	else \
-		echo "\nDeploying docs-demo site ..."; \
-        quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/ --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; \
-    fi
+    quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/ --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; \
 
 # Deployment to https://docs.validmind.ai/
 deploy-prod: