Updated Developer Fundamentals training

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

@@ -1,4 +1,4 @@
-name: Execute demo notebook
+name: Execute demo notebooks
 description: Installs python3, validmind, checks dependencies then executes ONLY the Intro for Model Developers notebook with development heap tracking
 
 inputs:
@@ -24,6 +24,11 @@ runs:
         pip install shap==0.44.1
         pip install anywidget
 
+    - name: Register validmind kernel
+      shell: bash
+      run: |
+        python -m ipykernel install --user --name validmind --display-name "ValidMind Library"
+
     - name: Ensure .env file is available
       shell: bash
       id: find_env
@@ -33,14 +38,14 @@ runs:
           exit 1
         fi
 
-    - name: Execute ONLY the Intro for Model Developers notebook with heap development
+    - name: Execute ONLY the ValidMind for model development series with heap development
       shell: bash
       if: ${{ steps.find_env.outcome == 'success' }}
       run: |
           cd site
           source ../${{ inputs.env_file }}
-          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";
+          quarto render --profile exe-demo notebooks/EXECUTED/model_development &> render_errors.log || {
+          echo "Execute for ValidMind for model development series failed";
           cat render_errors.log;
           exit 1;
           }

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

@@ -1,4 +1,4 @@
-name: Execute prod notebook
+name: Execute prod notebooks
 description: Installs python3, validmind, checks dependencies then executes ONLY the Intro for Model Developers notebook with production heap tracking
 
 inputs:
@@ -24,6 +24,11 @@ runs:
         pip install shap==0.44.1
         pip install anywidget
 
+    - name: Register validmind kernel
+      shell: bash
+      run: |
+        python -m ipykernel install --user --name validmind --display-name "ValidMind Library"
+
     - name: Ensure .env file is available
       shell: bash
       id: find_env
@@ -33,14 +38,14 @@ runs:
           exit 1
         fi
 
-    - name: Execute ONLY the Intro for Model Developers notebook with heap production
+    - name: Execute ONLY the ValidMind for model development series with heap production
       shell: bash
       if: ${{ steps.find_env.outcome == 'success' }}
       run: |
           cd site
           source ../${{ inputs.env_file }}
-          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";
+          quarto render --profile exe-prod notebooks/EXECUTED/model_development &> render_errors.log || {
+          echo "Execute for ValidMind for model development series failed";
           cat render_errors.log;
           exit 1;
           }

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

@@ -1,4 +1,4 @@
-name: Execute staging notebook
+name: Execute staging notebooks
 description: Installs python3, validmind, checks dependencies then executes ONLY the Intro for Model Developers notebook with staging heap tracking
 
 inputs:
@@ -24,6 +24,11 @@ runs:
         pip install shap==0.44.1
         pip install anywidget
 
+    - name: Register validmind kernel
+      shell: bash
+      run: |
+        python -m ipykernel install --user --name validmind --display-name "ValidMind Library"
+
     - name: Ensure .env file is available
       shell: bash
       id: find_env
@@ -33,14 +38,14 @@ runs:
           exit 1
         fi
 
-    - name: Execute ONLY the Intro for Model Developers notebook with heap staging
+    - name: Execute ONLY the ValidMind for model development series with heap staging
       shell: bash
       if: ${{ steps.find_env.outcome == 'success' }}
       run: |
           cd site
           source ../${{ inputs.env_file }}
-          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";
+          quarto render --profile exe-staging notebooks/EXECUTED/model_development &> render_errors.log || {
+          echo "Execute for iValidMind for model development series failed";
           cat render_errors.log;
           exit 1;
           }

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

@@ -59,7 +59,7 @@ jobs:
           cat .env
 
       # Only execute the prod notebook if .env file is created
-      - name: Execute prod Intro for Model Developers notebook
+      - name: Execute prod ValidMind for model development series
         if: ${{ steps.create_env.outcome == 'success' }}
         uses: ./.github/actions/prod-notebook
         id: execute-prod-notebook

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

@@ -49,7 +49,7 @@ jobs:
           cat .env
 
       # Only execute the staging notebook if .env file is created
-      - name: Execute staging Intro for Model Developers notebook
+      - name: Execute staging ValidMind for model development series
         if: ${{ steps.create_env.outcome == 'success' }}
         uses: ./.github/actions/staging-notebook
         id: execute-staging-notebook

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

@@ -72,8 +72,8 @@ jobs:
         cat .env
 
     # Only execute the demo notebook if .env file is created
-    - name: Execute demo Intro for Model Developers notebook
-      if: ${{ env.ENABLE_DEMO_NOTEBOOK == 'true' && steps.create_env.outcome == 'success' }}
+    - name: Execute demo ValidMind for model development series
+      if: ${{ vars.ENABLE_DEMO_NOTEBOOK == 'true' && steps.create_env.outcome == 'success' }}
       uses: ./.github/actions/demo-notebook
       id: execute-demo-notebook
       with:

site/Makefile

@@ -2,7 +2,7 @@
 DEST_DIR_NB := notebooks
 DEST_DIR_PYTHON := validmind
 DEST_DIR_TESTS := tests
-FILE_PATH := notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb 
+FILE_PATH := notebooks/EXECUTED/model_development
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 INSTALLATION_BRANCH := main
 LIBRARY_BRANCH ?= $(or $(BRANCH),main)
@@ -43,6 +43,7 @@ clean:
 	@echo "\nDeleting copies of files sourced from other repos ..."
 	rm -rf $(SRC_DIR)
 	rm -rf $(SRC_ROOT)
+	rm -rf notebooks/EXECUTED/model_development/
 
 # Prompt for a branch or release tag and clone the repository
 clone:
@@ -122,7 +123,7 @@ docs-site: get-source
 	quarto render --profile production
 	@$(MAKE) execute PROFILE=exe-prod
 
-# Will default to `exe-demo` profile & the `notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb` if no input provided
+# Will default to `exe-demo` profile & the `notebooks/EXECUTED/model_development` if no input provided
 execute:
 	quarto render --profile $(PROFILE) $(FILE_PATH)
 
@@ -135,8 +136,9 @@ notebooks:
 	@rm -f notebooks.zip
 	@rm -rf $(DEST_DIR_NB)/ && mkdir -p $(DEST_DIR_NB)
 	@cp -r $(SRC_DIR)/notebooks/. $(DEST_DIR_NB)/
-	@echo "Duplicating notebooks/tutorials/intro_for_model_developers.ipynb for execution"
-	@cp notebooks/tutorials/intro_for_model_developers.ipynb notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb
+	@echo "Duplicating all files from notebooks/tutorials/model_development/ for execution"
+	@mkdir -p notebooks/EXECUTED/model_development/
+	@cp -r notebooks/tutorials/model_development/* notebooks/EXECUTED/model_development/
 	@echo "Copying LICENSE into notebooks ..."
 	@cp -r $(SRC_DIR)/LICENSE $(DEST_DIR_NB)/
 	@rm -rf $(DEST_DIR_NB)/code_sharing

site/_quarto.yml

@@ -92,6 +92,8 @@ website:
           file: guide/guides.qmd
         - text: "{{< fa envelope-open-text >}} Support"
           file: support/support.qmd
+        - text: "{{< fa bullhorn >}} Releases"
+          file: releases/all-releases.qmd
         - text: "---"
         - text:  "{{< fa cube >}} Python Library"
         - text: "{{< fa code >}} {{< var validmind.developer >}}"
@@ -105,18 +107,18 @@ website:
         #   file: https://validmind.com/
         #   target: _blank
       # TRAINING MENU FOR ACADEMY SECTION
-      - text: "{{< fa graduation-cap >}} Training"
-        menu:
-        - text: "{{< fa house >}} ValidMind Academy"
-          file: training/training.qmd
-        - text: "---"
-        - text:  "{{< fa building-columns >}} Fundamentals"
-        - text: "{{< fa gear >}} For Administrators"
-          file: training/administrator-fundamentals/administrator-fundamentals-register.qmd
-        - text: "{{< fa code >}} For Developers"
-          file: training/developer-fundamentals/developer-fundamentals-register.qmd
-        - text: "{{< fa user-check >}} For Validators"
-          file: training/validator-fundamentals/validator-fundamentals-register.qmd
+      # - text: "{{< fa graduation-cap >}} Training"
+      #   menu:
+      #   - text: "{{< fa house >}} ValidMind Academy"
+      #     file: training/training.qmd
+      #   - text: "---"
+      #   - text:  "{{< fa building-columns >}} Fundamentals"
+      #   - text: "{{< fa gear >}} For Administrators"
+      #     file: training/administrator-fundamentals/administrator-fundamentals-register.qmd
+      #   - text: "{{< fa code >}} For Developers"
+      #     file: training/developer-fundamentals/developer-fundamentals-register.qmd
+      #   - text: "{{< fa user-check >}} For Validators"
+      #     file: training/validator-fundamentals/validator-fundamentals-register.qmd
       - text: "Log In"
         menu:
           - text: "Public Internet"

site/about/fine-print/data-privacy-policy.qmd

@@ -5,7 +5,7 @@ date: last-modified
 listing:
   id: legal-ease
   type: grid
-  grid-columns: 2
+  grid-columns: 1
   contents:
     - path: https://validmind.com/about/legal/
       title: "Legal Ease"
@@ -20,6 +20,17 @@ This page outlines {{< var vm.product >}}'s data privacy policy, explaining how
 
 Our goal is to provide transparency about our data handling practices and to demonstrate our commitment to protecting your privacy and data security.
 
+::: {.column-margin}
+[commitment to transparency]{.smallcaps .pink}
+
+Understanding our policies shouldn’t feel like deciphering code, so we’ve made our legal texts as clear and accessible as possible:
+<br><br>
+
+::: {#legal-ease}
+:::
+
+:::
+
 ## What is {{< var vm.product >}}'s data privacy policy?
 
 The key points of our data privacy policy include:
@@ -63,10 +74,3 @@ When you generate documentation or run tests, {{< var vm.product >}} imports the
 
 The {{< var validmind.developer >}} does not send any personally identifiable information (PII) through our {{< var validmind.api >}}. 
 
-## A commitment to transparency
-
-Understanding our policies shouldn’t feel like deciphering code, so we’ve made our legal texts as clear and accessible as possible: 
-
-::: {#legal-ease}
-:::
-

site/developer/validmind-library.qmd

@@ -19,8 +19,6 @@ listing:
     - path: https://youtu.be/rIR8Mql7eGs
       title: "{{< fa brands youtube >}} {{< var vm.product >}} QuickStart"
       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

site/guide/model-documentation/_test-result-metadata.qmd

@@ -0,0 +1,5 @@
+After you have added a test result to your document, you can view the following information attached to the result:
+
+- History of values for the result
+- What users wrote those results
+- Relevant inputs associated with the result

site/guide/model-documentation/_view-test-result-metadata.qmd

@@ -0,0 +1,8 @@
+1. Locate the test result whose metadata you want to view. 
+
+1. Hover over the test result until the top-right hand corner menu appears and select **{{< fa clock >}} See Timeline**:
+
+    - The [Active]{.green-bg} (most recent) test result is highlighted.
+    - On the test result timeline, click on the **{{< fa chevron-down >}}** associated with a test run to expand for details, such as **Model Information** or **Dataset Information**.
+
+    When you are done, you can either click **Cancel** or **{{< fa x >}}** to close the metadata menu.

site/guide/model-documentation/content_blocks/_generate-with-ai.qmd

@@ -0,0 +1,38 @@
+
+:::: {.content-visible unless-format="revealjs"}
+1. Click **{{< fa diamond >}} <sup>[beta]{.smallcaps}</sup> (Generate Text with AI)** in the toolbar while editing a content block.
+
+1. Enter an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review.  
+
+1. Review the draft composed by the {{< var vm.product >}} AI Content Builder for accuracy and relevance, then:
+
+   - Click **{{< fa download >}} Accept Text** to insert the draft into your content block.
+   - Click **{{< fa rotate >}} Try Again** to regenerate a different draft.
+   - Click **Cancel** to discard the draft and return to your documentation section. 
+
+1. After you insert the AI-generated draft, click on the text box to make the necessary edits and adjustments to your copy:
+
+   - Ensure that content is in compliance with the quality guidelines outlined by your organization. 
+   - Use the content editing toolbar^[[Content editing toolbar](#content-editing-toolbar)] just as you would with any other text block.
+
+![Generating content with AI within a simple text block](/guide/model-documentation/generate-with-ai.gif){width=90% fig-alt="An animation that showcases the Generate with AI feature within a simple text block" .screenshot}
+
+::::
+
+<!-- INLINE LINKS FOR REVEALJS TRAINING -->
+:::: {.content-hidden unless-format="revealjs"}
+1. Click **{{< fa diamond >}} <sup>[beta]{.smallcaps}</sup> (Generate Text with AI)** in the toolbar while editing a content block.
+
+1. Enter an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review.
+
+1. Review the draft composed by the {{< var vm.product >}} AI Content Builder for accuracy and relevance, then:
+
+   - Click **{{< fa download >}} Accept Text** to insert the draft into your content block.
+   - Click **{{< fa rotate >}} Try Again** to regenerate a different draft.
+   - Click **Cancel** to discard the draft and return to your documentation section.
+
+1. After you insert the AI-generated draft, click on the text box to make the necessary edits and adjustments to your copy, ensure that content is in compliance with the quality guidelines outlined by your organization.
+
+![Generating content with AI within a simple text block](/guide/model-documentation/generate-with-ai.gif){width=90% fig-alt="An animation that showcases the Generate with AI feature within a simple text block" .screenshot}
+
+::::

site/guide/model-documentation/work-with-content-blocks.qmd

@@ -5,9 +5,9 @@ aliases:
   - /guide/work-with-content-blocks.html
 ---
 
-Make edits to your model documentation, validation reports, or ongoing monitoring plans by adding or removing content blocks directly in the online editor. 
+Make edits to your model documentation, validation reports, or ongoing monitoring plans by adding or removing content blocks directly in the online editor.
 
-## What are content blocks? 
+## What are content blocks?
 
 Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, and ongoing monitoring plans.
 
@@ -90,24 +90,9 @@ Generating content drafts for your model documentation works best after you've l
 
 While editing a simple text block, you can have {{< var vm.product >}} assist you with generating content drafts:
 
-1. Click **{{< fa diamond >}} <sup>[beta]{.smallcaps}</sup> (Generate Text with AI)** in the toolbar while editing a content block.
+{{< include content_blocks/_generate-with-ai.qmd >}}
 
-2. Enter an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review.  
-
-3. Review the draft composed by the {{< var vm.product >}} AI Content Builder for accuracy and relevance, then:
-
-   - Click **{{< fa download >}} Accept Text** to insert the draft into your content block.
-   - Click **{{< fa rotate >}} Try Again** to regenerate a different draft.g
-   - Click **Cancel** to discard the draft and return to your documentation section. 
-
-4. After you insert the AI-generated draft, click on the text box to make the necessary edits and adjustments to your copy:
-
-   - Ensure that content is in compliance with the quality guidelines outlined by your organization. 
-   - Use the content editing toolbar[^9] just as you would with any other text block.
-
-![Generating content with AI within a simple text block](generate-with-ai.gif){width=90% fig-alt="An animation that showcases the Generate with AI feature within a simple text block" .screenshot}
-
-When generating content drafts with AI, accepted versions and edits are retained in your {{< fa wifi >}} Model Activity[^10] just like other updates to your documentation, reports, or plans. 
+When generating content drafts with AI, accepted versions and edits are retained in your {{< fa wifi >}} Model Activity[^9] just like other updates to your documentation, reports, or plans. 
 
 
 ## Remove content blocks
@@ -118,7 +103,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block
 
 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.[^11]
+2. Select a model or find your model by applying a filter or searching for it.[^10]
 
 3. In the left sidebar that appears for your model, click **{{< fa book-open >}} Documentation**, **{{< fa shield >}} Validation Report**, or **{{< fa desktop >}} Ongoing Monitoring**.
 
@@ -165,8 +150,6 @@ Test-driven or metric over time blocks can be re-added later on but **text block
 
 [^8]: [Run tests and test suites](/developer/model-testing/testing-overview.qmd)
 
-[^9]: [Content editing toolbar](#content-editing-toolbar)
-
-[^10]: [View model activity](/guide/model-inventory/view-model-activity.qmd)
+[^9]: [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)
+[^10]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)