July 24 2023 release notes & docs updates

site-unused/explore-validmind.qmd

@@ -106,7 +106,7 @@ Next, let's learn how to create your own documentation project. You can use this
 
    You can now access this project from the UI on the **Documentation Projects** page or by navigating to the relevant model - `[Quickstart] Customer Churn Model` - in the **Model Inventory** page.
 
-5. From the left sidebar, select **Client Integration**. 
+5. From the left sidebar, select **Getting started**. 
 
    The page that opens provides you with the credentials for the newly created project to use with the ValidMind Developer Framework. 
 

site/Makefile

@@ -22,24 +22,46 @@ help:
 
 # Clean up source directory
 clean:
+	@echo "\nDeleting copies of files sourced from other repos ..."
 	rm -rf $(SRC_DIR)
 
 # Clone the source repository we need
 clone:
+	@echo "\nCloning source repos ..."
 	git clone -b prod git@github.com:validmind/validmind-python.git $(SRC_DIR)
 
 # Copy over Jupyter notebooks
+
+NOTEBOOKS = \
+    notebooks/external_test_providers_demo.ipynb \
+    notebooks/external_tests/tests/MyCustomTest.py \
+    notebooks/how_to/implementing_custom_tests.ipynb \
+    notebooks/how_to/explore_test_suites_test_plans_and_tests.ipynb \
+    notebooks/how_to/run_a_template.ipynb \
+    notebooks/how_to/run_a_test.ipynb \
+    notebooks/how_to/run_a_test_plan.ipynb \
+    notebooks/how_to/run_a_test_suite.ipynb \
+    notebooks/nlp/nlp_sentiment_analysis_catboost_demo.ipynb \
+	notebooks/probability_of_default/credit_risk_scorecard_demo.ipynb \
+	notebooks/probability_of_default/probability_of_default_validmind.ipynb \
+    notebooks/time_series/tutorial_time_series_forecasting.ipynb 
+
 notebooks:
-	rm -rf $(DEST_DIR_NB)/ && mkdir -p $(DEST_DIR_NB)
-#	cp -r $(SRC_DIR)/notebooks/Quickstart_Customer Churn_full_suite.ipynb $(DEST_DIR_NB)/
-	mkdir -p $(DEST_DIR_NB)/how_to && cp -r $(SRC_DIR)/notebooks/how_to/. $(DEST_DIR_NB)/how_to
-	mkdir -p $(DEST_DIR_NB)/nlp && cp -r $(SRC_DIR)/notebooks/nlp/nlp_sentiment_analysis_demo.ipynb $(DEST_DIR_NB)/nlp/
-	mkdir -p $(DEST_DIR_NB)/time_series && cp -r $(SRC_DIR)/notebooks/time_series/tutorial_time_series_forecasting.ipynb $(DEST_DIR_NB)/time_series/
-	cp -r $(SRC_DIR)/notebooks/external_test_providers_demo.ipynb $(DEST_DIR_NB)/
-	mkdir -p $(DEST_DIR_NB)/tests && cp -r $(SRC_DIR)/notebooks/tests/MyCustomTest.py $(DEST_DIR_NB)/tests/
+	@echo "\nUpdating notebook source ..."
+	@rm -rf $(DEST_DIR_NB)/ > /dev/null 2>&1 && mkdir -p $(DEST_DIR_NB)
+	@$(foreach notebook,$(NOTEBOOKS), \
+		dest_dir=$(DEST_DIR_NB)/$(patsubst notebooks/%,%,$(dir $(notebook))); \
+		mkdir -p $$dest_dir > /dev/null 2>&1; \
+		cp -r $(SRC_DIR)/$(notebook) $$dest_dir > /dev/null 2>&1; \
+		echo "Updated $(notebook)"; \
+	)
+	@echo "\nCopying additional notebooks from Google Drive ..."
+	cp "$(HOME)/Google Drive/Shared drives/ValidMind Demo/Notebooks/Quickstart_Customer Churn_full_suite.ipynb" $(DEST_DIR_NB)/
+	cp "$(HOME)/Google Drive/Shared drives/ValidMind Demo/Notebooks/Introduction_Customer_Churn.ipynb" $(DEST_DIR_NB)/
 
 # Make Python library docs & copy them over
 python-docs:
+	@echo "\nUpdating Python documentation ..."
 	rm -rf $(DEST_DIR_PYTHON)
 	mkdir -p $(DEST_DIR_PYTHON)
 	cp -r $(SRC_DIR)/docs/_build/. $(DEST_DIR_PYTHON)
@@ -56,23 +78,20 @@ 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 "You're on the docs-demo branch. Deploying 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; \
+		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
 
 # Deployment to https://docs.validmind.ai/
 deploy-prod:
 	@if [ "`git rev-parse --abbrev-ref HEAD`" != "main" ] && [ "`git rev-parse --abbrev-ref HEAD`" != "prod" ]; then \
 		echo "You're not on the main or prod branches, no action taken."; \
 	else \
-		echo "You're on the main or prod branch. Deploying prod site ..."; \
-		quarto render && \
-		aws s3 sync ./_site s3://docs-ci-cd-prod/site/ --delete && \
-		aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager > /dev/null; \
+		echo "\nDeploying prod site ..."; \
+		quarto render && aws s3 sync ./_site s3://docs-ci-cd-prod/site/ --delete && aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager > /dev/null; \
 	fi
 
 # Generate release notes
 release-notes:
+	@echo "\nGenerating release notes ..."
 	python generate_release_notes.py

site/_quarto.yml

@@ -67,9 +67,11 @@ website:
 #          - guide/architecture.qmd
 #          - guide/cloud-platforms.qmd
           - guide/editions-and-features.qmd
-          - guide/license-agreement.qmd
+          - text: "Software license agreement"
+            file: guide/license-agreement.qmd
         - text: "Releases"
           contents:
+            - guide/release-notes-2023-jul-24.qmd
             - guide/release-notes-2023-jun-22.qmd
             - guide/release-notes-2023-may-30.qmd
 #        - file: guide/mrm.qmd
@@ -103,6 +105,7 @@ website:
           - guide/add-content-blocks.qmd
           - guide/load-credentials-to-env-file.qmd
           - guide/document-models-with-ui.qmd
+          - guide/swap-documentation-project-templates.qmd
           - guide/view-all-test-plans.qmd
           - guide/view-templates.qmd
           - guide/review-data-streams-and-audit-trails.qmd
@@ -117,6 +120,7 @@ website:
           - guide/collaborate-on-documentation-projects.qmd
           - guide/comment-on-documentation-projects.qmd
           - guide/work-with-validation-reports.qmd
+          - guide/swap-documentation-project-templates.qmd
   #       - guide/create-project-findings.qmd
   #       - guide/manage-project-findings.qmd
           - guide/view-validation-guidelines.qmd
@@ -143,14 +147,17 @@ website:
           - notebooks/how_to/run_a_test_plan.ipynb
           - notebooks/how_to/run_a_test_suite.ipynb
         - text: "---"
-        - text: "Jupyter notebooks"
-          file: guide/jupyter-notebooks.qmd
+        - text: "Samples"
+          file: guide/samples-jupyter-notebooks.qmd
           contents:
           - notebooks/Quickstart_Customer Churn_full_suite.ipynb
           - notebooks/Introduction_Customer_Churn.ipynb
           - notebooks/time_series/tutorial_time_series_forecasting.ipynb
           - text: "Sensitivity Analysis: Natural Language Processing Analysis & Binary Classification using pytorch"
-            file: notebooks/nlp/nlp_sentiment_analysis_demo.ipynb
+            file: notebooks/nlp/nlp_sentiment_analysis_catboost_demo.ipynb
+#          - notebooks/probability_of_default/credit_risk_scorecard_demo.ipynb
+#          - text: "Probability of Default Model"
+#            file: notebooks/probability_of_default/probability_of_default_validmind.ipynb
         - text: "---"
         - test: "Reference"
           file: guide/reference.qmd

site/_site/guide/add-content-blocks.html

@@ -231,6 +231,12 @@
   <a href="../guide/document-models-with-ui.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Document models with the ValidMind UI</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -303,6 +309,12 @@
   <a href="../guide/work-with-validation-reports.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Work with validation reports</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -355,7 +367,7 @@ <h1 class="title">Add content blocks to documentation</h1>
 
 </header>
 
-<p>Learn how to add a new content block to your documentation project, to write and update your model’s documentation.</p>
+<p>Learn how to add new content blocks to your documentation project, to write and update your model’s documentation. This topic is relevant for model developers and model validators who want to add new sections to a documentation project.</p>
 <section id="what-are-content-blocks" class="level2">
 <h2 class="anchored" data-anchor-id="what-are-content-blocks">What are content blocks?</h2>
 <p>Content blocks provide you with sections that are part of a template. You can think of these sections as an empty canvas that you fill in with text, metrics, and test results. Multiple sections are joined to create a longer document with a table of contents that has different heading and subheading levels, such as 1., 1.1., and so on.</p>
@@ -389,7 +401,7 @@ <h2 class="anchored" data-anchor-id="steps">Steps</h2>
 <li>Select one of the numbered sections, such as <strong>1.1 Model Overview</strong>.</li>
 </ol></li>
 <li><p>In your documentation, hover your mouse over the space where you want your new block to go until a horizontal dashed line with a <i class="fa-solid fa-square-plus" aria-label="square-plus"></i> sign appears that indicates you can insert a new block:</p>
-<p><img src="add-content-block.gif" class="img-fluid" style="width:50.0%"></p></li>
+<p><img src="add-content-block.gif" class="img-fluid" style="width:90.0%"></p></li>
 <li><p>Click <i class="fa-solid fa-square-plus" aria-label="square-plus"></i> and then select one of the available options:</p>
 <ul>
 <li><strong>Simple text block</strong>: Adds a new section with a blank content block. After the new content block has been added, click <i class="fa-solid fa-pencil" aria-label="pencil"></i> to edit the contents of the section like any other.</li>

site/_site/guide/before-you-begin.html

@@ -187,7 +187,7 @@ <h3 class="anchored" data-anchor-id="quickstart-requirements">Quickstart require
 <li><a href="../guide/try-developer-framework-with-docker.html">Docker Desktop</a></li>
 </ul>
 <p>To run our sample Jupyter notebooks locally, your developer environment must support Python 3.8+.</p>
-<!--- If you download the sample notebooks from Colab, [sample Jupyter notebooks](jupyter-notebooks.qmd), for use To use ourlocally requires Python 3.8+.  --->
+<!--- If you download the sample notebooks from Colab, [sample Jupyter notebooks](samples-jupyter-notebooks.qmd), for use To use ourlocally requires Python 3.8+.  --->
 </section>
 <section id="access-to-validminds-web-ui" class="level3">
 <h3 class="anchored" data-anchor-id="access-to-validminds-web-ui">Access to ValidMind’s Web UI</h3>

site/_site/guide/collaborate-on-documentation-projects.html

@@ -216,8 +216,8 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a content block to documentation</span></a>
+  <a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Add content blocks to documentation</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -231,6 +231,12 @@
   <a href="../guide/document-models-with-ui.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Document models with the ValidMind UI</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -303,6 +309,12 @@
   <a href="../guide/work-with-validation-reports.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Work with validation reports</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 

site/_site/guide/comment-on-documentation-projects.html

@@ -214,8 +214,8 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a content block to documentation</span></a>
+  <a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Add content blocks to documentation</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -229,6 +229,12 @@
   <a href="../guide/document-models-with-ui.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Document models with the ValidMind UI</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -301,6 +307,12 @@
   <a href="../guide/work-with-validation-reports.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Work with validation reports</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 

site/_site/guide/configure-aws-privatelink.html

@@ -214,8 +214,8 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a content block to documentation</span></a>
+  <a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Add content blocks to documentation</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -229,6 +229,12 @@
   <a href="../guide/document-models-with-ui.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Document models with the ValidMind UI</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -301,6 +307,12 @@
   <a href="../guide/work-with-validation-reports.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Work with validation reports</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 

site/_site/guide/create-documentation-project.html

@@ -229,6 +229,12 @@
   <a href="../guide/document-models-with-ui.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Document models with the ValidMind UI</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -301,6 +307,12 @@
   <a href="../guide/work-with-validation-reports.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Work with validation reports</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/swap-documentation-project-templates.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Swap Documentation Project Templates</span></a>
+  </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
@@ -391,7 +403,7 @@ <h2 class="anchored" data-anchor-id="steps">Steps</h2>
 </div></div><p>ValidMind has now created an empty documentation project associated with the model. You can access this project from the UI on the <strong>Documentation Projects</strong> page or by navigating to the relevant model details page in the <strong>Model Inventory</strong> page.</p>
 <ol start="5" type="1">
 <li><p>Locating the project identifier, API key and secret:</p>
-<p>On the <strong>Client Integration</strong> page of the newly created project, you can find the initialization code that enables the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:</p></li>
+<p>On the <strong>Getting started</strong> page of the newly created project, you can find the initialization code that enables the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:</p></li>
 </ol>
 <ul>
 <li><code>api_host</code>: The location of the ValidMind API</li>

site/_site/guide/create-your-first-documentation-project.html

@@ -233,7 +233,7 @@
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
   <a href="../guide/license-agreement.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">License agreement</span></a>
+ <span class="menu-text">Software license agreement</span></a>
   </div>
 </li>
       </ul>
@@ -249,6 +249,12 @@
       <ul id="" class="collapse list-unstyled sidebar-section depth1 show">  
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
+  <a href="../guide/release-notes-2023-jul-24.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">July 24, 2023</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
   <a href="../guide/release-notes-2023-jun-22.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">June 22, 2023</span></a>
   </div>
@@ -312,7 +318,7 @@ <h2 class="anchored" data-anchor-id="steps">Steps</h2>
 <li><p>Click <strong>Create Project</strong>.</p>
 <p>ValidMind will create an empty documentation project associated with the customer churn model.</p>
 <p>You can now access this project from the UI on the <strong>Documentation Projects</strong> page or by navigating to the relevant model - <code>[Quickstart] Customer Churn Model</code> - in the <strong>Model Inventory</strong> page.</p></li>
-<li><p>From the left sidebar, select <strong>Client Integration</strong>.</p>
+<li><p>From the left sidebar, select <strong>Getting started</strong>.</p>
 <p>The page that opens provides you with the credentials for the newly created project to use with the ValidMind Developer Framework.</p></li>
 <li><p>Locate the project identifier, API key, and secret:</p>
 <p><img src="client-integration.png" class="img-fluid"></p>