notebooks: Pulling in new Quickstart for model documentation

site/Makefile

@@ -182,8 +182,6 @@ notebooks:
 	@echo "Copying LICENSE into notebooks ..."
 	@cp -r $(SRC_DIR)/LICENSE $(DEST_DIR_NB)/
 	@rm -rf $(DEST_DIR_NB)/code_sharing
-	@echo "Moving Quickstart notebook into the root of notebooks/ ..."
-	@if [ -f "$(DEST_DIR_NB)/code_samples/quickstart_customer_churn_full_suite.ipynb" ]; then mv $(DEST_DIR_NB)/code_samples/quickstart_customer_churn_full_suite.ipynb $(DEST_DIR_NB)/quickstart_customer_churn_full_suite.ipynb; fi
 	@echo "Copying _metadata.yml into notebooks/ ..."
 	@cp developer/_metadata.yml $(DEST_DIR_NB)/_metadata.yml
 	@echo "Zip up notebooks.zip ..."

site/_quarto.yml

@@ -46,8 +46,8 @@ website:
           file: developer/validmind-library.qmd
         - text: "{{< fa cubes >}} Supported Models"
           file: developer/supported-models.qmd
-        - text: "{{< fa rocket >}} QuickStart Notebook"
-          file: notebooks/quickstart_customer_churn_full_suite.ipynb
+        - text: "{{< fa rocket >}} Documentation QuickStart"
+          file: notebooks/quickstart/quickstart_model_documentation.ipynb
         - text: "---"
         - text:  "{{< fa vial >}} TESTING"
         - text: "{{< fa flask-vial >}} Run Tests & Test Suites"

site/developer/_sidebar.yaml

@@ -9,7 +9,7 @@ website:
         - developer/supported-models.qmd
         - text: "---"
         - text: "QuickStart"
-        - notebooks/quickstart_customer_churn_full_suite.ipynb
+        - notebooks/quickstart/quickstart_model_documentation.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

site/developer/samples-jupyter-notebooks.qmd

@@ -52,7 +52,7 @@ JupyterHub
 : A a web-based platform when you can interact with Jupyter Notebook instances on a shared server. It is commonly used as a collaborative and interactive computing environment for data analysis, scientific research, and programming.
 
 ::: {.tc}
-[{{< fa code >}} Quickstart on JupyterHub]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb){.button target="_blank"}
+[{{< fa code >}} Quickstart on JupyterHub]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb){.button target="_blank"}
 
 :::
 

site/developer/validmind-library.qmd

@@ -15,7 +15,7 @@ listing:
     fields: [title, description]
     grid-columns: 2
     contents:
-    - ../notebooks/quickstart_customer_churn_full_suite.ipynb
+    - ../notebooks/quickstart/quickstart_model_documentation.ipynb
     - path: https://youtu.be/rIR8Mql7eGs
       title: "{{< fa brands youtube >}} {{< var vm.product >}} QuickStart"
       description: "Watch the walkthrough on YouTube: `https://youtu.be/rIR8Mql7eGs`"

site/get-started/developer/try-in-your-own-environment.qmd

@@ -41,7 +41,7 @@ Start by retrieving our notebook samples from GitHub, or download them from our
    git clone https://github.com/validmind/validmind-library.git
    ```
 
-4. After the cloning process is complete, open `notebooks/code_samples/quickstart_customer_churn_full_suite.ipynb` in your developer environment and [run the notebook](#run-the-notebook).
+4. After the cloning process is complete, open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your developer environment and [run the notebook](#run-the-notebook).
 
    The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}.
 
@@ -55,7 +55,7 @@ Start by retrieving our notebook samples from GitHub, or download them from our
 
 3. Navigate to the folder where you extracted the files.
 
-4. Open `notebooks/code_samples/quickstart_customer_churn_full_suite.ipynb` in your developer environment and [run the notebook](#run-the-notebook).
+4. Open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your developer environment and [run the notebook](#run-the-notebook).
 
    The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}.
 

site/get-started/developer/try-with-jupyterhub.qmd

@@ -22,7 +22,7 @@ Signing up is FREE — {{< var link.register >}}
 
 ## Steps
 
-1. In a web browser, open [Quickstart for model documentation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb).
+1. In a web browser, open [Quickstart for model documentation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb).
 
    This link takes you to {{< var vm.product >}}'s JupyterHub instance where you can log in with the Auth0 credentials for your {{< var vm.product >}} account to access the **QuickStart for model documentation** notebook:
 

site/notebooks/EXECUTED/model_development/2-start_development_process.ipynb

@@ -142,7 +142,7 @@
     "In our below example, note that: \n",
     "\n",
     "- The target column, `Exited` has a value of `1` when a customer has churned and `0` otherwise.\n",
-    "- The ValidMind Library provides a wrapper to automatically load the dataset as a Pandas DataFrame object."
+    "- The ValidMind Library provides a wrapper to automatically load the dataset as a [Pandas DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) object. A Pandas Dataframe is a two-dimensional tabular data structure that makes use of rows and columns."
    ]
   },
   {
@@ -887,7 +887,7 @@
     "\n",
     "### Assign predictions\n",
     "\n",
-    "Once the model has been registered you can assign model predictions to the training and test datasets.\n",
+    "Once the model has been registered you can assign model predictions to the training and testing datasets.\n",
     "\n",
     "- The [`assign_predictions()` method](https://docs.validmind.ai/validmind/validmind/vm_models.html#assign_predictions) from the `Dataset` object can link existing predictions to any number of models.\n",
     "- This method links the model's class prediction values and probabilities to our `vm_train_ds` and `vm_test_ds` datasets.\n",
@@ -959,7 +959,7 @@
     "\n",
     "- [x] Import a sample dataset\n",
     "- [x] Identify which tests you might want to run with ValidMind\n",
-    "- [x] Initialize ValidMind datasets\n",
+    "- [x] Initialize ValidMind datasets and model objects\n",
     "- [x] Run individual tests\n",
     "- [x] Utilize the output from tests you've run\n",
     "- [x] Log test results from sets of or individual tests as evidence to the ValidMind Platform\n",

site/notebooks/README.md

@@ -4,9 +4,10 @@ Our [Jupyter Notebook](https://jupyter.org/) code samples are designed to showca
 
 Sample notebooks are organized into the following folders:
 
-* `notebooks/code_samples` — Showcase end-to-end functionality for documenting models
-* `notebooks/how_to` — Learn how to use specific ValidMind features, e.g. how to list all test suites
+* `notebooks/quickstart` — Quick guides to get you started with ValidMind
 * `notebooks/tutorials` — Get step-by-step instructions and learn about ValidMind concepts in depth
+* `notebooks/how_to` — Learn how to use specific ValidMind features, for example how to list all test suites
+* `notebooks/code_samples` — Showcase end-to-end functionality for documenting or validating models
 * `notebooks/code_sharing` — Share your own notebooks or document code internally
 
 ## Getting started

site/notebooks/code_samples/custom_tests/implement_custom_tests.ipynb

@@ -426,7 +426,7 @@
    "source": [
     "Just so we can run all of the tests in the template, let's initialize the train and raw dataset.\n",
     "\n",
-    "(see the `quickstart_customer_churn_full_suite.ipynb` notebook and the ValidMind docs for more information on what we are doing here)"
+    "(Refer to [**Quickstart for model documentation**](../../quickstart/quickstart_model_documentation.ipynb) and the ValidMind docs for more information on what we are doing here)"
    ]
   },
   {