-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improves main README in several ways.
- Loading branch information
Showing
1 changed file
with
13 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,22 @@ | ||
# Aerospike Vector Search | ||
|
||
> [!NOTE] | ||
> Aerospike Vector Search (AVS) is currently in Alpha and available by invitation only. Breaking changes to our client and APIs are expected. Please refer to our [documentation](https://aerospike-vector-search.netlify.app/vector/) for more details and to request access. | ||
> Aerospike Vector Search (AVS) is currently in Beta. [Request an invite](https://aerospike.com/lp/aerospike-vector-search-preview-access/) | ||
This repo is a companion repo for scripts, and examples helpful for AVS users. See our full [full documentation](https://aerospike.com/docs/vector) for details how AVS works. | ||
|
||
## Sample Applications | ||
This repo contains sample apps for utilizing Aerospike Vector Search. All of the current | ||
apps are written in Python. The available apps are: | ||
## Installation Examples | ||
This repo contains scripts and configuration for installing AVS. | ||
For more details on AVS see our [install documentation](https://aerospike.com/docs/vector/operate/install). Here you will find. | ||
|
||
* [Kubernetes install script](./kubernetes) - A bash script and configuration for [Installing on Kubernetes](https://aerospike.com/docs/vector/operate/install/kubernetes). | ||
* [Docker-compose files](./docker) - The `./docker` folder contains a docker-compose file for deploying Aerospike, and AVS as containers. Additionaly each example app has a docker-compose file that deploys Aerospike, AVS and the application itself. | ||
|
||
|
||
## Example Applications | ||
This repo also contains example apps for developing using Aerospike Vector Search. This can give you the basics | ||
to start developing your own AVS application(s). | ||
|
||
* [Basic Search](./basic-search/README.md) - A simple application used to showcase the Python client. | ||
* [Quote Search](./quote-semantic-search/) - A application for semantic text search that includes a small dataset of quotes. | ||
* [Prism Image Search](./prism-image-search/) - An image search demo that can be used to search JPEG images (no sample dataset included). | ||
|
||
## Prerequisites | ||
You don't have to know Aerospike to get started, but you do need the following: | ||
|
||
1. A Python 3.10 - 3.11 environment and familiarity with the Python programming language (see [Setup Python Virtual Environment](#setup-python-virtual-environment)). | ||
1. The URL to your private sandbox environment (this will be provided). | ||
|
||
## Development | ||
To develop, you can run AVS using [docker](./docker/README.md), and each of the sample applications | ||
contains a docker-compose file that deploys all the necessary components. | ||
|
||
# Contributing | ||
If you have an idea for a sample application, open a PR and we will review it. We're excited to provide more examples of what Vector Search can do. |