Added new introductory validation notebooks

site/_quarto.yml

@@ -2,6 +2,7 @@ project:
   type: website
 
 metadata-files:
+  - developer/_sidebar.yaml
   - training/_sidebar.yaml
   - validmind/_sidebar.yml
   - installation/_sidebar.yaml
@@ -38,7 +39,7 @@ website:
         file: get-started/get-started.qmd
       - text: "Guides"
         file: guide/guides.qmd
-      - text: "{{< fa cube >}} Developers"
+      - text: "{{< fa cube >}} {{< var validmind.developer >}}"
         menu:
         - text: "{{< fa laptop-code >}} {{< var validmind.developer >}}"
           file: developer/validmind-library.qmd
@@ -64,15 +65,15 @@ website:
           file: https://jupyterhub.validmind.ai/
         - text: "---"
         - text: "{{< fa book >}} REFERENCE"
-        - text: "{{< var validmind.developer >}} API"
+        - text: "{{< var validmind.api >}}"
           file: validmind/validmind.qmd
       - text: "Support"
         file: support/support.qmd
       - text: "Training"
         file: training/training.qmd
-      - text: "validmind.com {{< fa external-link >}}"
-        file: https://validmind.com/
-        target: _blank
+      # - text: "validmind.com {{< fa external-link >}}"
+      #   file: https://validmind.com/
+      #   target: _blank
     right:
       # HOME BUTTON FOR DEVELOPER & TRAINING SECTIONS
       - text: "{{< fa house >}}"
@@ -89,17 +90,17 @@ website:
         - text: "{{< fa envelope-open-text >}} Support"
           file: support/support.qmd
         - text: "---"
-        - text:  "{{< fa cube >}} Developers"
+        - text:  "{{< fa cube >}} Python Library"
         - text: "{{< fa code >}} {{< var validmind.developer >}}"
           file: developer/validmind-library.qmd
         - text: "---"
         - text:  "{{< fa graduation-cap >}} {{< var validmind.training >}}"
         - text: "{{< fa building-columns >}} Training Courses"
           file: training/training.qmd
-        - text: "---"
-        - text: "{{< fa square-check >}} validmind.com {{< fa external-link >}}"
-          file: https://validmind.com/
-          target: _blank
+        # - text: "---"
+        # - text: "{{< fa square-check >}} validmind.com {{< fa external-link >}}"
+        #   file: https://validmind.com/
+        #   target: _blank
       # TRAINING MENU FOR ACADEMY SECTION
       - text: "{{< fa graduation-cap >}} Training"
         menu:
@@ -324,48 +325,6 @@ website:
           - guide/monitoring/review-monitoring-results.qmd
           - text: "Metrics over time"
             file: guide/monitoring/work-with-metrics-over-time.qmd
-
-    - title: "{{< var validmind.developer >}}"
-      contents:
-      # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW
-        - text: "ValidMind Library"
-          file: developer/validmind-library.qmd
-        - developer/supported-models.qmd
-        - text: "---"
-        - text: "QuickStart"
-        - notebooks/quickstart_customer_churn_full_suite.ipynb
-        - text: "Install and initialize ValidMind Library"
-          file: developer/model-documentation/install-and-initialize-validmind-library.qmd 
-        - developer/model-documentation/store-credentials-in-env-file.qmd
-        - text: "---"
-        - text: "Model Development"
-        # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
-        - text: "<sup>101</sup> Set up ValidMind Library"
-          file: notebooks/tutorials/model_development/101-set_up_validmind.ipynb
-        - text: "<sup>102</sup> Start model development process"
-          file: notebooks/tutorials/model_development/102-start_development_process.ipynb
-        - text: "<sup>103</sup> Integrate custom tests"
-          file: notebooks/tutorials/model_development/103-integrate_custom_tests.ipynb
-        - text: "<sup>104</sup> Finalize testing & documentation"
-          file: notebooks/tutorials/model_development/104-finalize_testing_documentation.ipynb
-        - text: "---"
-        - text: "Model Testing"
-        - text: "Run tests & test suites"
-          file: developer/model-testing/testing-overview.qmd
-          contents: "notebooks/how_to/**"
-        - text: "Test descriptions"
-          file: developer/model-testing/test-descriptions.qmd
-          contents: tests/**
-        - developer/model-testing/test-sandbox.qmd
-        - text: "---"
-        - text: "Notebooks"
-        - text: "Code samples"
-          file: developer/samples-jupyter-notebooks.qmd
-          contents: "notebooks/code_samples/**"
-        - text: "---"
-        - text: "Reference"
-        - text: "ValidMind Library API"
-          file: validmind/validmind.qmd
 
     - title: "Support"
       contents:

site/_variables.yml

@@ -19,7 +19,7 @@ validmind:
   developer: "ValidMind Library"
   product: "ValidMind AI risk platform"
   vpv: "Virtual Private ValidMind"
-  api: "Python Library API"
+  api: "ValidMind Library Python API"
   legal: "ValidMind Inc."
   training: "ValidMind Academy"
 

site/developer/_metadata.yml

@@ -1,4 +1,10 @@
 format:
   html:
+    grid:
+      sidebar-width: 450px
+      margin-width: 450px
     page-layout: full
-    css: /developer/developer.css 
+    from: markdown-smart
+    css:
+      - /validmind/validmind.css
+      - /developer/developer.css

site/developer/_sidebar.yaml

@@ -0,0 +1,55 @@
+website:
+  sidebar:
+    - id: validmind-library
+      title: "ValidMind Library"
+      contents:
+        # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW
+        - text: "ValidMind Library"
+          file: developer/validmind-library.qmd
+        - developer/supported-models.qmd
+        - text: "---"
+        - text: "QuickStart"
+        - notebooks/quickstart_customer_churn_full_suite.ipynb
+        - text: "Install and initialize ValidMind Library"
+          file: developer/model-documentation/install-and-initialize-validmind-library.qmd
+        - developer/model-documentation/store-credentials-in-env-file.qmd
+        - text: "---"
+        - text: "Model Development"
+        # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
+        - text: "1 — Set up ValidMind Library"
+          file: notebooks/tutorials/model_development/1-set_up_validmind.ipynb
+        - text: "2 — Start model development process"
+          file: notebooks/tutorials/model_development/2-start_development_process.ipynb
+        - text: "3 — Integrate custom tests"
+          file: notebooks/tutorials/model_development/3-integrate_custom_tests.ipynb
+        - text: "4 — Finalize testing & documentation"
+          file: notebooks/tutorials/model_development/4-finalize_testing_documentation.ipynb
+        - text: "---"
+        - text: "Model Validation"
+        # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
+        - text: "1 — Set up ValidMind Library for validation"
+          file: notebooks/tutorials/model_validation/1-set_up_validmind_for_validation.ipynb
+        - text: "2 — Start model validation process"
+          file: notebooks/tutorials/model_validation/2-start_validation_process.ipynb
+        - text: "3 — Developing a challenger model"
+          file: notebooks/tutorials/model_validation/3-developing_challenger_model.ipynb
+        - text: "4 — Finalize validation & reporting"
+          file: notebooks/tutorials/model_validation/4-finalize_validation_reporting.ipynb
+        - text: "---"
+        - text: "Model Testing"
+        - text: "Run tests & test suites"
+          file: developer/model-testing/testing-overview.qmd
+          contents: "notebooks/how_to/**"
+        - text: "Test descriptions"
+          file: developer/model-testing/test-descriptions.qmd
+          contents: tests/**
+        - developer/model-testing/test-sandbox.qmd
+        - text: "---"
+        - text: "Notebooks"
+        - text: "Code samples"
+          file: developer/samples-jupyter-notebooks.qmd
+          contents: "notebooks/code_samples/**"
+        - text: "---"
+        - text: "Reference"
+        - text: "{{< var validmind.api >}}"
+          file: validmind/validmind.qmd

site/developer/validmind-library.qmd

@@ -16,28 +16,45 @@ listing:
     grid-columns: 2
     contents:
     - ../notebooks/quickstart_customer_churn_full_suite.ipynb
-    - path: https://www.youtube.com/watch?v=rIR8Mql7eGs
+    - path: https://youtu.be/rIR8Mql7eGs
       title: "{{< fa brands youtube >}} {{< var vm.product >}} QuickStart"
-      description: "Watch the walkthrough on YouTube: `https://www.youtube.com/watch?v=rIR8Mql7eGs`"
+      description: "Watch the walkthrough on YouTube: `https://youtu.be/rIR8Mql7eGs`"
     # - ../notebooks/tutorials/intro_for_model_developers.ipynb
 #    - developer-getting-started-video.qmd
   - id: model-development
     type: grid
     grid-columns: 2
     max-description-length: 250
     contents:
-    - path: ../notebooks/tutorials/model_development/101-set_up_validmind.ipynb
-      title: "<sup>101</sup> Set up the {{< var validmind.developer >}}"
-      description: "Get to know {{< var vm.product >}} by setting up the {{< var validmind.developer >}} in your own environment and registering a sample binary classification model in the {{< var validmind.platform >}} for use with this series of notebooks."
-    - path: ../notebooks/tutorials/model_development/102-start_development_process.ipynb
-      title: "<sup>102</sup> Start the model development process"
+    - path: ../notebooks/tutorials/model_development/1-set_up_validmind.ipynb
+      title: "1 — Set up the {{< var validmind.developer >}}"
+      description: "Get to know {{< var vm.product >}} by setting up the {{< var validmind.developer >}} in your own environment, and registering a sample binary classification model in the {{< var validmind.platform >}} for use with this series of notebooks."
+    - path: ../notebooks/tutorials/model_development/2-start_development_process.ipynb
+      title: "2 — Start the model development process"
       description: "Learn to run and log tests with a variety of methods and in different situations with the {{< var validmind.developer >}}, then add the results or evidence to your documentation for the sample model you registered."
-    - path: ../notebooks/tutorials/model_development/103-integrate_custom_tests.ipynb
-      title: "<sup>103</sup> Integrate custom tests"
+    - path: ../notebooks/tutorials/model_development/3-integrate_custom_tests.ipynb
+      title: "3 — Integrate custom tests"
       description: "After you become familiar with the basics of the {{< var validmind.developer >}}, learn how to supplement ValidMind tests with your own and include them as additional evidence in your documentation. "
-    - path: ../notebooks/tutorials/model_development/104-finalize_testing_documentation.ipynb
-      title: "<sup>104</sup> Finalize testing and documentation"
+    - path: ../notebooks/tutorials/model_development/4-finalize_testing_documentation.ipynb
+      title: "4 — Finalize testing and documentation"
       description: "Wrap up by learning how to ensure that custom tests are included in your model's documentation template. By the end of this series, you will have a fully documented sample model ready for review."
+  - id: model-validation
+    type: grid
+    grid-columns: 2
+    max-description-length: 250
+    contents:
+    - path: ../notebooks/tutorials/model_validation/1-set_up_validmind_for_validation.ipynb
+      title: "1 — Set up the {{< var validmind.developer >}} for validation"
+      description: "Get to know {{< var vm.product >}} by setting up the {{< var validmind.developer >}} in your own environment, and gaining access as a validator to a sample model in the {{< var validmind.platform >}} for use with this series of notebooks."
+    - path: ../notebooks/tutorials/model_validation/2-start_validation_process.ipynb
+      title: "2 — Start the model validation process"
+      description: "Independently verify the data quality tests performed on datasets used to train the dummy champion model using tests from the {{< var validmind.developer >}}, then add the results or evidence to your validation report."
+    - path: ../notebooks/tutorials/model_validation/3-developing_challenger_model.ipynb
+      title: "3 — Developing a potential challenger model"
+      description: "After you become familiar with the basics of the {{< var validmind.developer >}}, use it to develop a potential challenger model and run thorough model comparison tests, such as performance, diagnostic, and feature importance tests."
+    - path: ../notebooks/tutorials/model_validation/4-finalize_validation_reporting.ipynb
+      title: "4 — Finalize validation and reporting"
+      description: "Wrap up by learning how to include custom tests and verifying that all tests conducted during model development were run and reported accurately. By the end of this series, you will have a validation report complete with findings ready for review."
   - id: run-tests
     grid-columns: 2
     type: grid
@@ -63,7 +80,7 @@ listing:
     max-description-length: 250
     sort: false
     fields: [title, description]
-    contents: 
+    contents:
     - ../guide/model-documentation/work-with-test-results.qmd
     - ../guide/model-documentation/work-with-content-blocks.qmd
 ---
@@ -73,12 +90,12 @@ The {{< var validmind.developer >}} helps you streamline model documentation by
 ## What is the {{< var validmind.developer >}}?
 
 The {{< var validmind.developer >}} provides a rich collection of documentation tools and test suites, from documenting descriptions of your dataset to validation testing your models for weak spots and overfit areas. 
- 
+
 {{< var vm.product >}} offers two primary methods for automating model documentation:
 
-- **Generate documentation** — Through automation, the {{< var vm.developer >}} extracts metadata from associated datasets and models for you and generates model documentation based on a template. You can also add more documentation and tests manually using the documentation editing capabilities in the {{< var validmind.platform >}}. 
+- **Generate documentation**[^1] — Through automation, the {{< var vm.developer >}} extracts metadata from associated datasets and models for you and generates model documentation based on a template. You can also add more documentation and tests manually using the documentation editing capabilities in the {{< var validmind.platform >}}.
 
-- **Run validation tests** — The {{< var vm.developer >}} provides a suite of validation tests for common financial services use cases. For cases where these tests do not cover everything you need, you can also extend existing test suites with your own proprietary tests or testing providers. 
+- **Run validation tests**[^2] — The {{< var vm.developer >}} provides a suite of validation tests for common financial services use cases. For cases where these tests do not cover everything you need, you can also extend existing test suites with your own proprietary tests or testing providers. 
 
 The {{< var validmind.developer >}} is designed to be model agnostic. If your model is built in Python, the {{< var vm.developer >}} provides all the standard functionality you may need without requiring you to rewrite any functions.
 
@@ -98,24 +115,35 @@ After you [**sign up**](/guide/configuration/accessing-validmind.qmd) for {{< va
 :::{#library-quickstart}
 :::
 
+<span id="development"></span>
+
 ## {{< var vm.product >}} for model development
 
 Learn how to use ValidMind for your end-to-end model documentation process based on common model development scenarios with our *ValidMind for model development* series of four introductory notebooks:
 
 :::{#model-development}
 :::
 
+<span id="validation"></span>
+
+## {{< var vm.product >}} for model validation
+
+Learn how to use ValidMind for your end-to-end model validation process based on common scenarios with our *ValidMind for model validation* series of four introductory notebooks:
+
+:::{#model-validation}
+:::
+
 
 ## Learn how to run tests
 
 :::: {.flex .flex-wrap .justify-around}
 
-::: {.w-80-ns}
-The {{< var validmind.developer >}} provides many built-in tests and test suites which make it easy for developers to automate their model documentation. Start by running a pre-made test, then modify it, and finally create your own test: 
+::: {.w-70-ns}
+The {{< var validmind.developer >}} provides many built-in tests and test suites which make it easy for developers to automate their model documentation. Start by running a pre-made test, then modify it, and finally create your own test:
 
 :::
 
-::: {.w-20-ns .tc}
+::: {.w-30-ns .tc}
 [Run tests & test suites](model-testing/testing-overview.qmd){.button .button-green}
 
 :::
@@ -129,12 +157,12 @@ The {{< var validmind.developer >}} provides many built-in tests and test suites
 
 :::: {.flex .flex-wrap .justify-around}
 
-::: {.w-80-ns}
+::: {.w-70-ns}
 Our code samples showcase the capabilities of the {{< var validmind.developer >}}. Examples that you can build on and adapt for your own use cases include:
 
 :::
 
-::: {.w-20-ns .tc}
+::: {.w-30-ns .tc}
 [All code samples](samples-jupyter-notebooks.qmd){.button .button-green}
 
 :::
@@ -148,17 +176,24 @@ Our code samples showcase the capabilities of the {{< var validmind.developer >}
 
 :::: {.flex .flex-wrap .justify-around}
 
-::: {.w-70-ns}
+::: {.w-60-ns}
 After you have tried out the {{< var validmind.developer >}}, continue working with your model documentation in the {{< var validmind.platform >}}:
 
 :::
 
-::: {.w-30-ns .tc}
+::: {.w-40-ns .tc}
 [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd){.button .button-green}
 
 :::
 
 ::::
 
 :::{#library-documentation}
-:::
+:::
+
+
+<!-- FOOTNOTES -->
+
+[^1]: [{{< var vm.product >}} for model development](#development)
+
+[^2]: [{{< var vm.product >}} for model validation](#validation)

site/notebooks/_metadata.yml

@@ -1,4 +1,10 @@
 format:
   html:
+    grid:
+      sidebar-width: 450px
+      margin-width: 450px
     page-layout: full
-    css: /developer/developer.css 
+    from: markdown-smart
+    css:
+      - /validmind/validmind.css
+      - /developer/developer.css

site/notebooks/code_samples/capital_markets/quickstart_option_pricing_models.ipynb

@@ -82,7 +82,7 @@
     "\n",
     "### New to ValidMind?\n",
     "\n",
-    "If you haven't already seen our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models, find code samples, or read our developer reference.\n",
+    "If you haven't already seen our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models and running tests, as well as find code samples and our Python Library API reference.\n",
     "\n",
     "<div class=\"alert alert-block alert-info\" style=\"background-color: #f7e4ee; color: black; border: 1px solid black;\"><b>For access to all features available in this notebook, create a free ValidMind account.</b>\n",
     "<br></br>\n",

site/notebooks/code_samples/capital_markets/quickstart_option_pricing_models_quantlib.ipynb

@@ -120,7 +120,7 @@
     "\n",
     "### New to ValidMind?\n",
     "\n",
-    "If you haven't already seen our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models, find code samples, or read our developer reference.\n",
+    "If you haven't already seen our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models and running tests, as well as find code samples and our Python Library API reference.\n",
     "\n",
     "<div class=\"alert alert-block alert-info\" style=\"background-color: #f7e4ee; color: black; border: 1px solid black;\"><b>For access to all features available in this notebook, create a free ValidMind account.</b>\n",
     "<br></br>\n",