Skip to content

Commit 1658c07

Browse files
committed
minor changes
1 parent 862fb44 commit 1658c07

File tree

3 files changed

+9
-17
lines changed

3 files changed

+9
-17
lines changed

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ To set the model execution timeout to 1 second from the command line use the fol
8181

8282
```
8383
redis-server --loadmodule /usr/lib/redis/modules/redisai.so \
84-
MODEL_EXECUTION_TIMEOUT 1
84+
MODEL_EXECUTION_TIMEOUT 1000
8585
```
8686

8787
## Backend

docs/developer.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,26 +38,26 @@ This is the entry point of the RedisAI module, responsible for registering the n
3838

3939
The header file that contains the module's low-level-API. This file should be copied to a Redis module that plan on using RedisAI objects and functionality via low-level-API. Note that every function in redisai.h is named "RedisAI_{X}", and detailed description for it can be found under the name "RAI_{X}" in RedisAI header files.
4040

41-
**redis_ai_types directory**
41+
**redis_ai_types**
4242

4343
Contains the callbacks that are required for the new Tensor, Model and Script types. These callbacks are used by Redis server for data management and persistence.
4444

4545
**redis_ai_objects**
4646

4747
Contains the internal implementation of the basic RedisAI objects - Tensor, Model and Script.
4848
For each object there is a header file that contains the helper methods for both creating, populating, managing and freeing the data structure.
49-
This also includes `stats.h` where you can find the structure and headers that create, initialize, get, reset, and free run-time statics, like call count, error count, and aggregate durations of Model and Script execution sessions. Note that the statistics are ephemeral, meaning that they are not persisted to the Redis key space, and are reset when the server is restarted.
49+
This directory also includes `stats.h` where you can find the structure and headers that create, initialize, get, reset, and free run-time statistics, like call count, error count, and aggregate durations of Model and Script execution sessions. Note that the statistics are ephemeral, meaning that they are not persisted to the Redis key space, and are reset when the server is restarted.
5050

5151
**execution**
5252

53-
Contains the files and logic that are responsible for RedisAI execution commands. The structure of RedisAI "execution plan" can be found in `run_info.h` along with the headers that create, initialize, get, and free this structure .
54-
Every execution is represented as a DAG (directional acyclic graph) of one or more operation. Execution requests are queued and executed asynchronously. `run_queue_info.h` contains the structure for managing per-device queues that are used for decoupling the work from the main thread to the background worker threads.
53+
Contains the files and logic that are responsible for RedisAI execution commands. The structure of RedisAI "execution plan" can be found in `run_info.h` along with the headers that create, initialize, get, and free this structure.
54+
Every execution is represented as a DAG (directional acyclic graph) of one or more operations. Execution requests are queued and executed asynchronously. `run_queue_info.h` contains the structure for managing per-device queues that are used for decoupling the work from the main thread to the background worker threads.
5555
`background_workers.c` contains the loop that every worker runs in the process of execution requests.
5656
The execution directory contains the following sub-directories:
5757

58-
* DAG - contains the methods for creating, initializing and freeing DAG operations, methods for building DAG from low-level API, and methods for running the DAG commands in the background, and replying to DAG structured commands. Also, this contains methods for validating the entire DAG and sending its operation to the appropriate execution queues.
58+
* DAG - contains the methods for creating, initializing and freeing DAG operations, methods for building DAG from low-level API, and methods for running the DAG commands in the background, and replying to DAG structured commands. Also, this contains methods for validating the entire DAG and sending its operations to the appropriate execution queues.
5959
* execution_context - contains the structure and methods for running an instance of a Model and Script in RedisAI.
60-
* parsing - here we can find the parsing logic execution related RedisAI commands.
60+
* parsing - here we can find the parsing logic of execution related RedisAI commands.
6161

6262
**config**
6363

@@ -117,16 +117,6 @@ make
117117
make GPU=1
118118
```
119119

120-
After this, you can run the created docker and mount your source code with the following command, from within the RedisAI folder.
121-
Assuming that the docker was built for ubuntu bionic machine with cpu-only support (the default parameters) from master branch, you can run:
122-
123-
```
124-
docker run -v "`pwd`:/build" -it redislabs/redisai:edge-cpu-bionic bash
125-
```
126-
127-
Continue to edit files on your local machine, and rebuild as needed within the docker, by running the command below, from */build* in the docker:
128-
129-
```make -C opt all```
130120

131121
**Building on bare metal**
132122

docs/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,14 @@ bash get_deps.sh gpu
6060
Once the dependencies have been built, you can build the RedisAI module with:
6161

6262
```sh
63+
make -C opt clean ALL=1
6364
make -C opt
6465
```
6566

6667
Alternatively, run the following to build RedisAI with GPU support:
6768

6869
```sh
70+
make -C opt clean ALL=1
6971
make -C opt GPU=1
7072
```
7173

0 commit comments

Comments
 (0)