notebooks: Update templates & notebooks with 'document' parameter in vm.init()

notebooks/code_sharing/clustering/quickstart_cluster_demo.ipynb

@@ -34,68 +34,100 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
-   "metadata": {
-    "id": "ZNcbDRubSPc1"
-   },
+   "id": "setup-intro",
+   "metadata": {},
    "source": [
-    "## Before you begin\n",
-    "\n",
-    "To use the ValidMind Library with a Jupyter notebook, you need to install and initialize the ValidMind Library first, along with getting your Python environment ready. When running this notebook locally, this includes installing any missing prerequisite modules that you discover with `pip install`. "
+    "## Setting up"
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
+   "id": "setup-install",
    "metadata": {},
    "source": [
-    "## Install the ValidMind Library\n",
+    "### Install the ValidMind Library\n",
+    "\n",
+    "<div class=\"alert alert-block alert-info\" style=\"background-color: #B5B5B510; color: black; border: 1px solid #083E44; border-left-width: 5px; box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.2);border-radius: 5px;\"><span style=\"color: #083E44;\"><b>Recommended Python versions</b></span>\n",
+    "<br></br>\n",
+    "Python 3.8 <= x <= 3.11</div>\n",
     "\n",
     "To install the library:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "id": "6G5-kHOZ7YWk"
-   },
+   "id": "install-code",
+   "metadata": {},
    "outputs": [],
    "source": [
     "%pip install -q validmind"
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
-   "metadata": {
-    "id": "_ZqI8W5jSPc1"
-   },
+   "id": "setup-initialize",
+   "metadata": {},
    "source": [
-    "## Initialize the ValidMind Library\n",
-    "\n",
-    "ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the ValidMind Library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n",
+    "### Initialize the ValidMind Library"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "register-model",
+   "metadata": {},
+   "source": [
+    "#### Register sample model\n",
     "\n",
-    "### Get your code snippet\n",
+    "Let's first register a sample model for use with this notebook.\n",
     "\n",
     "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n",
     "\n",
-    "2. In the left sidebar, navigate to **Model Inventory** and click **+ Register Model**.\n",
+    "2. In the left sidebar, navigate to **Inventory** and click **+ Register Model**.\n",
     "\n",
-    "3. Enter the model details and click **Continue**. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/register-models-in-inventory.html))\n",
+    "3. Enter the model details and click **Next >** to continue to assignment of model stakeholders. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/register-models-in-inventory.html))\n",
     "\n",
-    "4. Go to **Getting Started** and click **Copy snippet to clipboard**.\n",
+    "4. Select your own name under the **MODEL OWNER** drop-down.\n",
     "\n",
-    "Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/model-documentation/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:"
+    "5. Click **Register Model** to add the model to your inventory."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "apply-template",
+   "metadata": {},
+   "source": [
+    "#### Apply documentation template\n",
+    "\n",
+    "Once you've registered your model, let's select a documentation template. A template predefines sections for your model documentation and provides a general outline to follow, making the documentation process much easier.\n",
+    "\n",
+    "1. In the left sidebar that appears for your model, click **Documents** and select **Development**.\n",
+    "\n",
+    "2. Under **TEMPLATE**, select `{template}`.\n",
+    "\n",
+    "3. Click **Use Template** to apply the template."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "code-snippet",
+   "metadata": {},
+   "source": [
+    "#### Get your code snippet\n",
+    "\n",
+    "Initialize the ValidMind Library with the *code snippet* unique to each model per document, ensuring your test results are uploaded to the correct model and automatically populated in the right document in the ValidMind Platform when you run this notebook.\n",
+    "\n",
+    "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n",
+    "2. Click **Copy snippet to clipboard**.\n",
+    "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/model-documentation/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "id": "5hqGn9jHSPc2"
-   },
+   "id": "initialize-code",
+   "metadata": {},
    "outputs": [],
    "source": [
     "# Load your model identifier credentials from an `.env` file\n",
@@ -112,10 +144,32 @@
     "    # api_key=\"...\",\n",
     "    # api_secret=\"...\",\n",
     "    # model=\"...\",\n",
-    "    #document=\"documentation\",\n",
+    "    document=\"documentation\",\n",
     ")"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "preview-template",
+   "metadata": {},
+   "source": [
+    "### Preview the documentation template\n",
+    "\n",
+    "Let's verify that you have connected the ValidMind Library to the ValidMind Platform and that the appropriate *template* is selected for your model. A template predefines sections for your model documentation and provides a general outline to follow, making the documentation process much easier.\n",
+    "\n",
+    "You will upload documentation and test results unique to your model based on this template later on. For now, **take a look at the default structure that the template provides with [the `vm.preview_template()` function](https://docs.validmind.ai/validmind/validmind.html#preview_template)** from the ValidMind library and note the empty sections:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "template-code",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "vm.preview_template()"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",
@@ -390,24 +444,43 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
+   "id": "next-steps",
    "metadata": {},
    "source": [
     "## Next steps\n",
     "\n",
-    "You can look at the results of this test suite right in the notebook where you ran the code, as you would expect. But there is a better way: view the test results as part of your model documentation right in the ValidMind Platform: \n",
+    "You can look at the output produced by the ValidMind Library right in the notebook where you ran the code, as you would expect. But there is a better way — use the ValidMind Platform to work with your model documentation."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "next-document",
+   "metadata": {},
+   "source": [
+    "### Work with your model documentation\n",
+    "\n",
+    "1. From the **Inventory** in the ValidMind Platform, go to the model you registered earlier. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/working-with-model-inventory.html))\n",
+    "\n",
+    "2. In the left sidebar that appears for your model, click **Development** under Documents.\n",
     "\n",
-    "1. In the ValidMind Platform, click **Documentation** under Documents for the model you registered earlier. ([Need more help?](https://docs.validmind.ai/guide/model-documentation/working-with-model-documentation.html)\n",
+    "What you see is the full draft of your model documentation in a more easily consumable version. From here, you can make qualitative edits to model documentation, view guidelines, collaborate with validators, and submit your model documentation for approval when it's ready. [Learn more ...](https://docs.validmind.ai/guide/working-with-model-documentation.html)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "next-resources",
+   "metadata": {},
+   "source": [
+    "### Discover more learning resources\n",
     "\n",
-    "2. Expand the following sections and take a look around:\n",
-    "   \n",
-    "   - **2. Data Preparation**\n",
-    "   - **3. Model Development**\n",
+    "We offer many interactive notebooks to help you automate testing, documenting, validating, and more:\n",
     "\n",
-    "What you can see now is a much more easily consumable version of the documentation, including the results of the tests you just performed, along with other parts of your model documentation that still need to be completed. There is a wealth of information that gets uploaded when you run the full test suite, so take a closer look around, especially at test results that might need attention (hint: some of the tests in 2.1 Data description look like they need some attention).\n",
+    "- [Run tests & test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n",
+    "- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n",
+    "- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n",
     "\n",
-    "If you want to learn more about where you are in the model documentation process, take a look at our documentation on the [ValidMind Library](https://docs.validmind.ai/developer/validmind-library.html).\n"
+    "Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind."
    ]
   },
   {

notebooks/code_sharing/credit_risk/assign_prediction_probabilities.ipynb

@@ -68,12 +68,17 @@
     "\n",
     "### Install the ValidMind Library\n",
     "\n",
+    "<div class=\"alert alert-block alert-info\" style=\"background-color: #B5B5B510; color: black; border: 1px solid #083E44; border-left-width: 5px; box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.2);border-radius: 5px;\"><span style=\"color: #083E44;\"><b>Recommended Python versions</b></span>\n",
+    "<br></br>\n",
+    "Python 3.8 <= x <= 3.11</div>\n",
+    "\n",
     "To install the library:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
+   "id": "install-code",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -97,7 +102,7 @@
     "\n",
     "#### Register sample model\n",
     "\n",
-    "Let's first register a sample model for use with this notebook:\n",
+    "Let's first register a sample model for use with this notebook.\n",
     "\n",
     "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n",
     "\n",
@@ -120,7 +125,7 @@
     "\n",
     "Once you've registered your model, let's select a documentation template. A template predefines sections for your model documentation and provides a general outline to follow, making the documentation process much easier.\n",
     "\n",
-    "1. In the left sidebar that appears for your model, click **Documents** and select **Documentation**.\n",
+    "1. In the left sidebar that appears for your model, click **Documents** and select **Development**.\n",
     "\n",
     "2. Under **TEMPLATE**, select `Binary classification`.\n",
     "\n",
@@ -135,15 +140,17 @@
     "\n",
     "#### Get your code snippet\n",
     "\n",
-    "ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the ValidMind Library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n",
+    "Initialize the ValidMind Library with the *code snippet* unique to each model per document, ensuring your test results are uploaded to the correct model and automatically populated in the right document in the ValidMind Platform when you run this notebook.\n",
     "\n",
-    "1. On the left sidebar that appears for your model, select **Getting Started** and click **Copy snippet to clipboard**.\n",
-    "2. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/model-documentation/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:"
+    "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n",
+    "2. Click **Copy snippet to clipboard**.\n",
+    "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/model-documentation/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
+   "id": "initialize-code",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -161,7 +168,7 @@
     "    # api_key=\"...\",\n",
     "    # api_secret=\"...\",\n",
     "    # model=\"...\",\n",
-    "    # document=\"documentation\",\n",
+    "    document=\"documentation\",\n",
     ")"
    ]
   },
@@ -173,14 +180,15 @@
     "\n",
     "### Preview the documentation template\n",
     "\n",
-    "Let's verify that you have connected the ValidMind Library to the ValidMind Platform and that the appropriate *template* is selected for your model.\n",
+    "Let's verify that you have connected the ValidMind Library to the ValidMind Platform and that the appropriate *template* is selected for your model. A template predefines sections for your model documentation and provides a general outline to follow, making the documentation process much easier.\n",
     "\n",
     "You will upload documentation and test results unique to your model based on this template later on. For now, **take a look at the default structure that the template provides with [the `vm.preview_template()` function](https://docs.validmind.ai/validmind/validmind.html#preview_template)** from the ValidMind library and note the empty sections:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
+   "id": "template-code",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -736,7 +744,6 @@
   },
   {
    "cell_type": "markdown",
-   "id": "copyright-0871b365e3924d0995a276dbbbcf62c1",
    "metadata": {},
    "source": [
     "<!-- VALIDMIND COPYRIGHT -->\n",