Skip to content

Commit 583f09d

Browse files
Update installation docs and readme (#61)
Updates to README and main docs page to highlight the installation routine. Also fixes the PyPI badge on our README
1 parent 55d9106 commit 583f09d

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1919
![GitHub last commit](https://img.shields.io/github/last-commit/RedisVentures/RedisVL)
2020
![GitHub deployments](https://img.shields.io/github/deployments/RedisVentures/RedisVL/github-pages?label=doc%20build)
21-
![pypi](https://badge.fury.io/py/redisvl.svg)](https://pypi.org/project/redisvl/)
21+
[![pypi](https://badge.fury.io/py/redisvl.svg)](https://pypi.org/project/redisvl/)
2222

2323
</div>
2424

@@ -34,7 +34,7 @@ RedisVL provides a powerful Python client library for using Redis as a Vector Da
3434

3535
Vector databases have become increasingly popular in recent years due to their ability to store and retrieve vectors efficiently. However, most vector databases are complex to use and require a lot of time and effort to set up. RedisVL aims to solve this problem by providing a simple and intuitive interface for using Redis as a vector database.
3636

37-
RedisVL provides a client library that enables you to harness the power of Redis as a vector database. This library simplifies the process of storing, retrieving, and performing semantic searches on vectors in Redis. It also provides a robust index management system that allows you to create, update, and delete indices with ease.
37+
RedisVL provides a client library that enables you to harness the power and flexibility of Redis as a vector database. This library simplifies the process of storing, retrieving, and performing complex semantic and hybrid searches over vectors in Redis. It also provides a robust index management system that allows you to create, update, and delete indices with ease.
3838

3939

4040
### Capabilities
@@ -43,7 +43,7 @@ RedisVL has a host of powerful features designed to streamline your vector datab
4343

4444
1. **Index Management**: RedisVL allows for indices to be created, updated, and deleted with ease. A schema for each index can be defined in yaml or directly in python code and used throughout the lifetime of the index.
4545

46-
2. **Embedding Creation**: RedisVL integrates with OpenAI and other text embedding providers to simplify the process of vectorizing unstructured data. *Image support coming soon.*
46+
2. **Embedding Creation**: RedisVL integrates with OpenAI, HuggingFace, and GCP VertexAI to simplify the process of vectorizing unstructured data. *Image support coming soon. Submit a PR for new vectorizers.*
4747

4848
3. **Vector Search**: RedisVL provides robust search capabilities that enable you to query vectors synchronously and asynchronously. Hybrid queries that utilize tag, geographic, numeric, and other filters like full-text search are also supported.
4949

@@ -55,20 +55,20 @@ RedisVL has a host of powerful features designed to streamline your vector datab
5555

5656
Please note that this library is still under heavy development, and while you can quickly try RedisVL and deploy it in a production environment, the API may be subject to change at any time.
5757

58-
First, install RedisVL using pip:
58+
Install `redisvl` using `pip`:
5959

60-
```
60+
```bash
6161
pip install redisvl
6262
```
6363

64-
Then make sure to have Redis with the Search and Query capability running on Redis Cloud or
65-
locally in docker by running
64+
Then make sure to have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
6665

6766
```bash
68-
docker run -d -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
67+
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
6968
```
7069

71-
This will also spin up the Redis Insight UI at http://localhost:8001
70+
This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
71+
7272

7373

7474
## Example Usage
@@ -80,7 +80,6 @@ Indices can be defined through yaml specification that corresponds directly to t
8080
```yaml
8181
index:
8282
name: user_index
83-
storage_type: hash
8483
prefix: users
8584

8685
fields:
@@ -95,6 +94,7 @@ fields:
9594
# define vector fields
9695
vector:
9796
- name: user_embedding
97+
dim: 3
9898
algorithm: hnsw
9999
distance_metric: cosine
100100
```

docs/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,22 @@ to supercharge your application!
3131
link: "examples/index"
3232
```
3333

34+
## Installation
35+
36+
Install `redisvl` using `pip`:
37+
38+
```bash
39+
pip install redisvl
40+
```
41+
42+
Then make sure to have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
43+
44+
```bash
45+
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
46+
```
47+
48+
This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
49+
3450
## Table of Contents
3551

3652
```{toctree}

0 commit comments

Comments
 (0)