Skip to content

Commit cf6c1d4

Browse files
Update Redis product naming conventions (#530)
Redis Query Engine and RediSearch --> Redis Search Removed the use of Redis Stack completely
1 parent 5601ef0 commit cf6c1d4

33 files changed

Lines changed: 3963 additions & 3974 deletions

.github/workflows/test.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
matrix:
6565
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
6666
redis-py-version: ["5.x", "6.x", "7.x"]
67-
redis-image: ["redis/redis-stack-server:latest", "redis:latest"]
67+
redis-image: ["redis:8.2", "redis:8.4", "redis:latest"]
6868
steps:
6969
- name: Check out repository
7070
uses: actions/checkout@v6
@@ -118,7 +118,7 @@ jobs:
118118
uses: google-github-actions/auth@v1
119119
if: (
120120
matrix.redis-py-version == '7.x' &&
121-
matrix.redis-image == 'redis/redis-stack-server:latest' &&
121+
matrix.redis-image == 'redis:8.4' &&
122122
matrix.python-version == '3.11' &&
123123
(github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository)
124124
)
@@ -128,7 +128,7 @@ jobs:
128128
- name: Run notebooks
129129
if: (
130130
matrix.redis-py-version == '7.x' &&
131-
matrix.redis-image == 'redis/redis-stack-server:latest' &&
131+
matrix.redis-image == 'redis:8.4' &&
132132
matrix.python-version == '3.11' &&
133133
(github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository)
134134
)
@@ -147,7 +147,7 @@ jobs:
147147
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
148148
HF_TOKEN: ${{ secrets.HF_TOKEN }}
149149
run: |
150-
docker run -d --name redis -p 6379:6379 redis/redis-stack-server:latest
150+
docker run -d --name redis -p 6379:6379 redis:8.4
151151
make test-notebooks
152152
153153
docs:

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ make test-all # Run all tests (includes API tests)
1313
make check # Full check (lint + test)
1414

1515
# Redis setup
16-
make redis-start # Start Redis Stack container
17-
make redis-stop # Stop Redis Stack container
16+
make redis-start # Start Redis container
17+
make redis-stop # Stop Redis container
1818

1919
# Documentation
2020
make docs-build # Build documentation

CONTRIBUTING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Here's how to get started with your code contribution:
3232
### Prerequisites
3333

3434
- **Python**: RedisVL supports Python 3.9 and above
35-
- **Docker**: Required for running Redis Stack and integration tests
35+
- **Docker**: Required for running Redis and integration tests
3636
- **UV**: Modern Python package manager for fast dependency management
3737

3838
### Installing UV
@@ -88,8 +88,8 @@ We provide a comprehensive Makefile to streamline common development tasks. Here
8888
| Command | Description |
8989
|---------|-------------|
9090
| `make install` | Installs all dependencies using UV |
91-
| `make redis-start` | Starts Redis Stack in a Docker container on ports 6379 and 8001 |
92-
| `make redis-stop` | Stops the Redis Stack Docker container |
91+
| `make redis-start` | Starts Redis in a Docker container on port 6379 |
92+
| `make redis-stop` | Stops the Redis Docker container |
9393
| `make format` | Runs code formatting and import sorting |
9494
| `make check-types` | Runs mypy type checking |
9595
| `make lint` | Runs formatting, import sorting, and type checking |
@@ -106,7 +106,7 @@ We provide a comprehensive Makefile to streamline common development tasks. Here
106106
# Set up the project
107107
make install
108108

109-
# Start Redis Stack
109+
# Start Redis
110110
make redis-start
111111

112112
# Run linting and tests
@@ -194,26 +194,24 @@ uv run python -m http.server 8000 --directory docs/_build/html
194194

195195
## Redis Setup
196196

197-
To develop and test RedisVL applications, you need Redis with Search & Query features. You have several options:
197+
To develop and test RedisVL applications, you need Redis with Redis Search enabled. You have several options:
198198

199-
### Option 1: Redis Stack with Docker (Recommended for Development)
199+
### Option 1: Redis with Docker (Recommended for Development)
200200

201201
```bash
202-
# Start Redis Stack with RedisInsight GUI
202+
# Start Redis
203203
make redis-start
204204

205205
# This runs:
206-
# docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
206+
# docker run -d --name redis -p 6379:6379 redis:8.4
207207

208208
# Stop when finished
209209
make redis-stop
210210
```
211211

212-
This also provides the [FREE RedisInsight GUI](https://redis.io/insight/) at `http://localhost:8001`.
213-
214212
### Option 2: Redis Cloud
215213

216-
For production-like testing, use [Redis Cloud](https://redis.io/cloud/) which provides managed Redis instances with Search & Query capabilities.
214+
For production-like testing, use [Redis Cloud](https://redis.io/cloud/) which provides managed Redis instances with Redis Search capabilities.
217215

218216
## Reporting Issues
219217

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ install: ## Install the project and all dependencies
1010

1111
redis-start: ## Start Redis in Docker
1212
@echo "🐳 Starting Redis"
13-
docker run -d --name redis -p 6379:6379 redis:latest
13+
docker run -d --name redis -p 6379:6379 redis:8.4
1414
@sleep 1
1515
@docker exec redis redis-cli INFO server | grep redis_version
1616

docs/api/schema.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ SVS-VAMANA (Scalable Vector Search with VAMANA graph algorithm) provides fast ap
269269
:color: info
270270

271271
**Requirements:**
272-
- Redis >= 8.2.0 with RediSearch >= 2.8.10
272+
- Redis >= 8.2.0 with Redis Search >= 2.8.10
273273
- datatype must be 'float16' or 'float32' (float64/bfloat16 not supported)
274274

275275
**Use SVS-VAMANA when:**
@@ -353,7 +353,7 @@ SVS-VAMANA (Scalable Vector Search with VAMANA graph algorithm) provides fast ap
353353
354354
**Important Notes:**
355355

356-
- **Requirements**: SVS-VAMANA requires Redis >= 8.2 with RediSearch >= 2.8.10.
356+
- **Requirements**: SVS-VAMANA requires Redis >= 8.2 with Redis Search >= 2.8.10.
357357
- **Datatype limitations**: SVS-VAMANA only supports `float16` and `float32` datatypes (not `bfloat16` or `float64`).
358358
- **Compression compatibility**: The `reduce` parameter is only valid with LeanVec compression types (`LeanVec4x8` or `LeanVec8x8`).
359359
- **Platform considerations**: Intel's proprietary LVQ and LeanVec optimizations are not available in Redis Open Source. On non-Intel platforms and Redis Open Source, SVS-VAMANA with compression falls back to basic 8-bit scalar quantization.
@@ -511,7 +511,7 @@ Migration Considerations
511511
- Tune ``ef_runtime`` at query time to balance speed vs accuracy (no index rebuild needed)
512512

513513
**From HNSW to SVS-VAMANA:**
514-
- Requires Redis >= 8.2 with RediSearch >= 2.8.10
514+
- Requires Redis >= 8.2 with Redis Search >= 2.8.10
515515
- Change datatype to float16 or float32 if using others
516516
- Consider compression options for memory savings
517517

docs/concepts/field-attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Key vector attributes:
285285

286286
### Modifier Ordering
287287

288-
RediSearch has specific requirements for the order of field modifiers. RedisVL handles this automatically, but it's useful to understand:
288+
Redis Search has specific requirements for the order of field modifiers. RedisVL handles this automatically, but it's useful to understand:
289289

290290
**Canonical order**: `INDEXEMPTY` → `INDEXMISSING` → `SORTABLE` → `UNF` → `NOINDEX`
291291

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ pip install redisvl
2424
```
2525

2626
```bash
27-
docker run -d --name redis -p 6379:6379 redis:latest
27+
docker run -d --name redis -p 6379:6379 redis:8.4
2828
```
2929

3030
Or connect to [Redis Cloud](https://redis.io/cloud) for a managed experience.

docs/user_guide/09_svs_vamana.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"\n",
1414
"Before you begin, ensure you have:\n",
1515
"- Installed RedisVL: `pip install redisvl`\n",
16-
"- A running Redis instance with Redis >= 8.2.0 and RediSearch >= 2.8.10 ([Redis 8+](https://redis.io/downloads/) or [Redis Cloud](https://redis.io/cloud))\n",
16+
"- A running Redis instance with Redis >= 8.2.0 and Redis Search >= 2.8.10 ([Redis 8+](https://redis.io/downloads/) or [Redis Cloud](https://redis.io/cloud))\n",
1717
"\n",
1818
"> **Note:** SVS-VAMANA only supports FLOAT16 and FLOAT32 datatypes.\n",
1919
"\n",

docs/user_guide/cli.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"\n",
1313
"Before running this notebook, be sure to\n",
1414
"1. Have installed ``redisvl`` and have that environment active for this notebook.\n",
15-
"2. Have a running Redis instance with the Search and Query capability"
15+
"2. Have a running Redis instance with Redis Search enabled"
1616
]
1717
},
1818
{

docs/user_guide/installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,26 +120,26 @@ $ pre-commit run --all-files
120120

121121
## Installing Redis
122122

123-
RedisVL requires a distribution of Redis that supports the [Search and Query](https://redis.com/modules/redis-search/) capability. There are several options:
123+
RedisVL requires Redis with [Redis Search](https://redis.io/docs/latest/develop/ai/search-and-query/) available. There are several options:
124124

125125
1. [Redis Cloud](https://redis.io/cloud), a fully managed cloud offering with a free tier
126126
2. [Redis 8+ (Docker)](https://redis.io/downloads/), for local development and testing
127127
3. [Redis Enterprise](https://redis.com/redis-enterprise/), a commercial self-hosted option
128128

129129
### Redis Cloud
130130

131-
Redis Cloud is the easiest way to get started with RedisVL. You can sign up for a free account [here](https://redis.io/cloud). Make sure to have the `Search and Query`
132-
capability enabled when creating your database.
131+
Redis Cloud is the easiest way to get started with RedisVL. You can sign up for a free account [here](https://redis.io/cloud). Make sure to have `Redis Search`
132+
enabled when creating your database.
133133

134134
### Redis 8+ (local development)
135135

136136
For local development and testing, we recommend running Redis 8+ in a Docker container:
137137

138138
```bash
139-
docker run -d --name redis -p 6379:6379 redis:latest
139+
docker run -d --name redis -p 6379:6379 redis:8.4
140140
```
141141

142-
Redis 8 includes built-in vector search capabilities.
142+
Redis 8 includes Redis Search and built-in vector search capabilities.
143143

144144
### Redis Enterprise (self-hosted)
145145

0 commit comments

Comments
 (0)