Merge pull request #964 from vespa-engine/thomasht86/formatting-colpa…

…li-notebook (notebook) formatting and a paragraph about certs
vespa-engine · Nov 4, 2024 · 7d73bfc · 7d73bfc
2 parents 1697ba2 + 6e4762e
commit 7d73bfc
Showing 1 changed file with 22 additions and 25 deletions.
diff --git a/docs/sphinx/source/examples/visual_pdf_rag_with_vespa_colpali_cloud.ipynb b/docs/sphinx/source/examples/visual_pdf_rag_with_vespa_colpali_cloud.ipynb
@@ -20,6 +20,7 @@
     "\n",
     "The main goal of the demo is to make it easy for _you_ to create your own PDF Enterprise Search application using Vespa.\n",
     "To deploy a full demo, you need two main components:\n",
+    "\n",
     "1. A Vespa application that lets you index and search PDF pages using ColPali embeddings.\n",
     "2. A live web application that lets you interact with the Vespa application. \n",
     "\n",
@@ -29,6 +30,7 @@
     "You can then test that you are able to query the Vespa application, and you will be ready to deploy the web application including the frontend.\n",
     "\n",
     "Some of the features we want to highlight in this demo are:\n",
+    "\n",
     "- Visual retrieval of PDF pages using ColPali embeddings\n",
     "- Explainability by displaying similarity maps over the patches in the PDF pages for each query token.\n",
     "- Extracting queries and questions from the PDF pages using `gemini-1.5-8b` model.\n",
@@ -1891,7 +1893,12 @@
     "id": "bdd6ab1c"
    },
    "source": [
-    "Great. You have now deployed the Vespa application and fed the data to it, and made sure you are able to query it using the vespa endpoint and a token."
+    "Great. You have now deployed the Vespa application and fed the data to it, and made sure you are able to query it using the vespa endpoint and a token.\n",
+    "\n",
+    "### Saving the generated key/cert files\n",
+    "\n",
+    "A key and cert file is generated for you as an alternative to using tokens for authentication.\n",
+    "We advise you to save these files in a secure location, in case you want to use them for authentication in the future."
    ]
   },
   {
@@ -1935,7 +1942,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 77,
+   "execution_count": 17,
    "id": "03e5aee0",
    "metadata": {},
    "outputs": [
@@ -1947,22 +1954,22 @@
       "remote: Enumerating objects: 575, done.\u001b[K\n",
       "remote: Counting objects: 100% (575/575), done.\u001b[K\n",
       "remote: Compressing objects: 100% (306/306), done.\u001b[K\n",
-      "remote: Total 575 (delta 6), reused 537 (delta 6), pack-reused 0 (from 0)\u001b[K\n",
-      "Receiving objects: 100% (575/575), 55.77 KiB | 1.24 MiB/s, done.\n",
+      "remote: Total 575 (delta 6), reused 536 (delta 6), pack-reused 0 (from 0)\u001b[K\n",
+      "Receiving objects: 100% (575/575), 55.67 KiB | 1.50 MiB/s, done.\n",
       "Resolving deltas: 100% (6/6), done.\n",
       "remote: Enumerating objects: 16, done.\u001b[K\n",
       "remote: Counting objects: 100% (16/16), done.\u001b[K\n",
       "remote: Compressing objects: 100% (15/15), done.\u001b[K\n",
       "remote: Total 16 (delta 2), reused 8 (delta 1), pack-reused 0 (from 0)\u001b[K\n",
-      "Receiving objects: 100% (16/16), 82.73 KiB | 1020.00 KiB/s, done.\n",
+      "Receiving objects: 100% (16/16), 82.73 KiB | 1.29 MiB/s, done.\n",
       "Resolving deltas: 100% (2/2), done.\n",
-      "remote: Enumerating objects: 27, done.\u001b[K\n",
-      "remote: Counting objects: 100% (27/27), done.\u001b[K\n",
-      "remote: Compressing objects: 100% (26/26), done.\u001b[K\n",
-      "remote: Total 27 (delta 1), reused 16 (delta 0), pack-reused 0 (from 0)\u001b[K\n",
-      "Receiving objects: 100% (27/27), 19.09 MiB | 20.02 MiB/s, done.\n",
+      "remote: Enumerating objects: 26, done.\u001b[K\n",
+      "remote: Counting objects: 100% (26/26), done.\u001b[K\n",
+      "remote: Compressing objects: 100% (25/25), done.\u001b[K (12/25)\u001b[K\n",
+      "remote: Total 26 (delta 1), reused 13 (delta 0), pack-reused 0 (from 0)\u001b[K\n",
+      "Receiving objects: 100% (26/26), 19.04 MiB | 10.39 MiB/s, done.\n",
       "Resolving deltas: 100% (1/1), done.\n",
-      "Updating files: 100% (28/28), done.\n"
+      "Updating files: 100% (27/27), done.\n"
      ]
     }
    ],
@@ -1980,34 +1987,24 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 78,
+   "execution_count": 18,
    "id": "34e30c3d",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "['tailwind.config.js',\n",
-       " 'frontend',\n",
-       " 'requirements.txt',\n",
-       " 'uv.lock',\n",
-       " 'icons.py',\n",
+       "['uv.lock',\n",
        " 'pyproject.toml',\n",
-       " 'backend',\n",
        " 'README.md',\n",
        " 'prepare_feed_deploy.py',\n",
        " '.gitignore',\n",
-       " 'static',\n",
-       " 'ruff.toml',\n",
        " '.env.example',\n",
        " 'vespa_feed_to_hf_dataset.py',\n",
-       " 'main.py',\n",
-       " 'tailwindcss',\n",
-       " 'output.css',\n",
-       " 'globals.css']"
+       " 'src']"
       ]
      },
-     "execution_count": 78,
+     "execution_count": 18,
      "metadata": {},
      "output_type": "execute_result"
     }