Skip to content

Commit c458c5f

Browse files
authored
Merge pull request #956 from jcaw07/jcaw-changes
Changed name from RedisAI to redis-inference-optimization
2 parents 2fc312d + 75775e0 commit c458c5f

File tree

1 file changed

+25
-48
lines changed

1 file changed

+25
-48
lines changed

README.md

+25-48
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,19 @@
1-
[![GitHub issues](https://img.shields.io/github/release/RedisAI/RedisAI.svg?sort=semver)](https://github.com/RedisAI/RedisAI/releases/latest)
2-
[![CircleCI](https://circleci.com/gh/RedisAI/RedisAI/tree/master.svg?style=svg)](https://circleci.com/gh/RedisAI/RedisAI/tree/master)
3-
[![Dockerhub](https://img.shields.io/badge/dockerhub-redislabs%2Fredisai-blue)](https://hub.docker.com/r/redislabs/redisai/tags/)
4-
[![codecov](https://codecov.io/gh/RedisAI/RedisAI/branch/master/graph/badge.svg)](https://codecov.io/gh/RedisAI/RedisAI)
5-
[![Total alerts](https://img.shields.io/lgtm/alerts/g/RedisAI/RedisAI.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RedisAI/RedisAI/alerts/)
6-
[![Forum](https://img.shields.io/badge/Forum-RedisAI-blue)](https://forum.redislabs.com/c/modules/redisai)
7-
[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/rTQm7UZ)
8-
91
> [!CAUTION]
10-
> **RedisAI is no longer actively maintained or supported.**
2+
> **Redis-inference-optimization is no longer actively maintained or supported.**
113
>
12-
> We are grateful to the RedisAI community for their interest and support.
13-
14-
# RedisAI
15-
RedisAI is a Redis module for executing Deep Learning/Machine Learning models and managing their data. Its purpose is being a "workhorse" for model serving, by providing out-of-the-box support for popular DL/ML frameworks and unparalleled performance. **RedisAI both maximizes computation throughput and reduces latency by adhering to the principle of data locality**, as well as simplifies the deployment and serving of graphs by leveraging on Redis' production-proven infrastructure.
4+
> We are grateful to the redis-inference-optimization community for their interest and support.
5+
> Previously, redis-inference-optimization was named RedisAI, but was renamed in Jan 2025 to reduce confusion around Redis' other AI offerings. To learn more about Redis' current AI offerings, visit [the Redis website](https://redis.io/redis-for-ai).
166
17-
To read RedisAI docs, visit [redisai.io](https://oss.redis.com/redisai/). To see RedisAI in action, visit the [demos page](https://oss.redis.com/redisai/examples/).
7+
# Redis-inference-optimization
8+
Redis-inference-optimization is a Redis module for executing Deep Learning/Machine Learning models and managing their data. Its purpose is being a "workhorse" for model serving, by providing out-of-the-box support for popular DL/ML frameworks and unparalleled performance. **Redis-inference-optimization both maximizes computation throughput and reduces latency by adhering to the principle of data locality**, as well as simplifies the deployment and serving of graphs by leveraging on Redis' production-proven infrastructure.
189

1910
# Quickstart
20-
RedisAI is a Redis module. To run it you'll need a Redis server (v6.0.0 or greater), the module's shared library, and its dependencies.
11+
Redis-inference-optimization is a Redis module. To run it you'll need a Redis server (v6.0.0 or greater), the module's shared library, and its dependencies.
2112

22-
The following sections describe how to get started with RedisAI.
13+
The following sections describe how to get started with redis-inference-optimization.
2314

2415
## Docker
25-
The quickest way to try RedisAI is by launching its official Docker container images.
16+
The quickest way to try redis-inference-optimization is by launching its official Docker container images.
2617
### On a CPU only machine
2718
```
2819
docker run -p 6379:6379 redislabs/redisai:1.2.7-cpu-bionic
@@ -37,7 +28,7 @@ docker run -p 6379:6379 --gpus all -it --rm redislabs/redisai:1.2.7-gpu-bionic
3728

3829

3930
## Building
40-
You can compile and build the module from its source code. The [Developer](https://oss.redis.com/redisai/developer/) page has more information about the design and implementation of the RedisAI module and how to contribute.
31+
You can compile and build the module from its source code.
4132

4233
### Prerequisites
4334
* Packages: git, python3, make, wget, g++/clang, & unzip
@@ -49,17 +40,17 @@ You can compile and build the module from its source code. The [Developer](https
4940
You can obtain the module's source code by cloning the project's repository using git like so:
5041

5142
```sh
52-
git clone --recursive https://github.com/RedisAI/RedisAI
43+
git clone --recursive https://github.com/RedisAI/redis-inference-optimization
5344
```
5445

5546
Switch to the project's directory with:
5647

5748
```sh
58-
cd RedisAI
49+
cd redis-inference-optimization
5950
```
6051

6152
### Building the Dependencies
62-
Use the following script to download and build the libraries of the various RedisAI backends (TensorFlow, PyTorch, ONNXRuntime) for CPU only:
53+
Use the following script to download and build the libraries of the various redis-inference-optimization backends (TensorFlow, PyTorch, ONNXRuntime) for CPU only:
6354

6455
```sh
6556
bash get_deps.sh
@@ -72,14 +63,14 @@ bash get_deps.sh gpu
7263
```
7364

7465
### Building the Module
75-
Once the dependencies have been built, you can build the RedisAI module with:
66+
Once the dependencies have been built, you can build the redis-inference-optimization module with:
7667

7768
```sh
7869
make -C opt clean ALL=1
7970
make -C opt
8071
```
8172

82-
Alternatively, run the following to build RedisAI with GPU support:
73+
Alternatively, run the following to build redis-inference-optimization with GPU support:
8374

8475
```sh
8576
make -C opt clean ALL=1
@@ -88,59 +79,45 @@ make -C opt GPU=1
8879

8980
### Backend Dependancy
9081

91-
RedisAI currently supports PyTorch (libtorch), Tensorflow (libtensorflow), TensorFlow Lite, and ONNXRuntime as backends. This section shows the version map between RedisAI and supported backends. This extremely important since the serialization mechanism of one version might not match with another. For making sure your model will work with a given RedisAI version, check with the backend documentation about incompatible features between the version of your backend and the version RedisAI is built with.
82+
Redis-inference-optimization currently supports PyTorch (libtorch), Tensorflow (libtensorflow), TensorFlow Lite, and ONNXRuntime as backends. This section shows the version map between redis-inference-optimization and supported backends. This extremely important since the serialization mechanism of one version might not match with another. For making sure your model will work with a given redis-inference-optimization version, check with the backend documentation about incompatible features between the version of your backend and the version redis-inference-optimization is built with.
9283

9384

94-
| RedisAI | PyTorch | TensorFlow | TFLite | ONNXRuntime |
85+
| redis-inference-optimization | PyTorch | TensorFlow | TFLite | ONNXRuntime |
9586
|:--------|:--------:|:----------:|:------:|:-----------:|
9687
| 1.0.3 | 1.5.0 | 1.15.0 | 2.0.0 | 1.2.0 |
9788
| 1.2.7 | 1.11.0 | 2.8.0 | 2.0.0 | 1.11.1 |
9889
| master | 1.11.0 | 2.8.0 | 2.0.0 | 1.11.1 |
9990

100-
Note: Keras and TensorFlow 2.x are supported through graph freezing. See [this script](http://dev.cto.redis.s3.amazonaws.com/RedisAI/test_data/tf2-minimal.py
101-
) to see how to export a frozen graph from Keras and TensorFlow 2.x.
91+
Note: Keras and TensorFlow 2.x are supported through graph freezing.
10292

10393
## Loading the Module
10494
To load the module upon starting the Redis server, simply use the `--loadmodule` command line switch, the `loadmodule` configuration directive or the [Redis `MODULE LOAD` command](https://redis.io/commands/module-load) with the path to module's library.
10595

10696
For example, to load the module from the project's path with a server command line switch use the following:
10797

10898
```sh
109-
redis-server --loadmodule ./install-cpu/redisai.so
99+
redis-server --loadmodule ./install-cpu/redis-inference-optimization.so
110100
```
111101

112102
### Give it a try
113103

114-
Once loaded, you can interact with RedisAI using redis-cli. Basic information and examples for using the module is described [here](https://oss.redis.com/redisai/intro/#getting-started).
104+
Once loaded, you can interact with redis-inference-optimization using redis-cli.
115105

116106
### Client libraries
117-
Some languages already have client libraries that provide support for RedisAI's commands. The following table lists the known ones:
107+
Some languages already have client libraries that provide support for redis-inference-optimization's commands. The following table lists the known ones:
118108

119109
| Project | Language | License | Author | URL |
120110
| ------- | -------- | ------- | ------ | --- |
121-
| JRedisAI | Java | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/JRedisAI) |
122-
| redisai-py | Python | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisai-py) |
123-
| redisai-go | Go | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisai-go) |
124-
| redisai-js | Typescript/Javascript | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisai-js) |
111+
| JredisAI | Java | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/redis-inference-optimization/JRedisAI) |
112+
| redisAI-py | Python | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/redisAI/redisAI-py) |
113+
| redisAI-go | Go | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisAI-go) |
114+
| redisAI-js | Typescript/Javascript | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/redisAI/redisAI-js) |
125115
| redis-modules-sdk | TypeScript | BSD-3-Clause | [Dani Tseitlin](https://github.com/danitseitlin) | [Github](https://github.com/danitseitlin/redis-modules-sdk) |
126116
| redis-modules-java | Java | Apache-2.0 | [dengliming](https://github.com/dengliming) | [Github](https://github.com/dengliming/redis-modules-java) |
127117
| smartredis | C++ | BSD-2-Clause | [Cray Labs](https://github.com/CrayLabs) | [Github](https://github.com/CrayLabs/SmartRedis) |
128118
| smartredis | C | BSD-2-Clause | [Cray Labs](https://github.com/CrayLabs) | [Github](https://github.com/CrayLabs/SmartRedis) |
129119
| smartredis | Fortran | BSD-2-Clause | [Cray Labs](https://github.com/CrayLabs) | [Github](https://github.com/CrayLabs/SmartRedis) |
130120
| smartredis | Python | BSD-2-Clause | [Cray Labs](https://github.com/CrayLabs) | [Github](https://github.com/CrayLabs/SmartRedis) |
131121

132-
133-
134-
The full documentation for RedisAI's API can be found at the [Commands page](commands.md).
135-
136-
## Documentation
137-
Read the docs at [redisai.io](https://oss.redis.com/redisai/).
138-
139-
## Contact Us
140-
If you have questions, want to provide feedback or perhaps report an issue or [contribute some code](contrib.md), here's where we're listening to you:
141-
142-
* [Forum](https://forum.redis.com/c/modules/redisai)
143-
* [Repository](https://github.com/RedisAI/RedisAI/issues)
144-
145122
## License
146-
RedisAI is licensed under your choice of the Redis Source Available License 2.0 (RSALv2) or the Server Side Public License v1 (SSPLv1).
123+
Redis-inference-optimization is licensed under your choice of the Redis Source Available License 2.0 (RSALv2) or the Server Side Public License v1 (SSPLv1).

0 commit comments

Comments
 (0)