From 5267e2dbd4042f06058f32af5d937329c4e517d0 Mon Sep 17 00:00:00 2001 From: dylan Date: Thu, 15 Aug 2024 10:53:23 -0700 Subject: [PATCH] add AVS setup note --- basic-search/basic_search.ipynb | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/basic-search/basic_search.ipynb b/basic-search/basic_search.ipynb index aa0bd9d..053c62b 100644 --- a/basic-search/basic_search.ipynb +++ b/basic-search/basic_search.ipynb @@ -5,12 +5,19 @@ "id": "c60c757f-2f3a-4a84-9a8f-09adfc1d3d72", "metadata": {}, "source": [ - "AVS provides a gRPC API and a Python client that developers can use to create AI applications leveraging the search capability.\n", + "## Overview\n", "\n", - "## Prerequisites\n", + "AVS provides a gRPC API and a Python client that developers can use to create AI applications leveraging its search capability. This example shows basic usage of the Aerospike Vector Search Python client including, writing, reading, and searching for vectors with AVS. For more detailed client documentation visit the [Python client's read the docs page](https://aerospike-vector-search-python-client.readthedocs.io/en/latest/).\n", + "\n", + "## Setup\n", + "Before getting started, you need to setup a running Aerospike Vector Search (AVS) deployment.\n", + "See the [AVS installation guide](https://aerospike.com/docs/vector/install) for tips on setting up AVS.\n", + "\n", + "### Prerequisites\n", "\n", "- Python 3.9 or higher\n", "- pip 9.0.1 or higher\n", + "- An accessible AVS deployment\n", "\n", "## Installing the Aerospike Vector Search Client\n", "\n", @@ -61,7 +68,9 @@ "source": [ "## Creating a Vector Admin Client\n", "\n", - "Initialize a new admin client by providing one or more seed hosts to which the client can connect." + "Initialize a new admin client by providing one or more seed hosts to which the client can connect. If your AVS deployment is not running on \"localhost\" at port \"5000\" please change the `host` and `port` variables to match your deployment.\n", + "\n", + "If your AVS deployment is not accessible on address \"localhost\" and port \"5000\" change the `host` and `port` variables below to match your deployment." ] }, {