ONNXRuntime backend (#138)

* WIP adding ONNXRuntime

* WIP2 adding ONNXRuntime

* Add comment

* Remove commented code

* Implement DLTensor conversion from/to ORT Value

* ONNX runtime working

* Complete first pass of ONNXRuntime integration

* Updated docs

* Updated README

* Don't release info too soon. Thanks to @hhsecond for catching the crash

* Bump the base image on CI

* Address review comments

Author: lantiga

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/python:3.6.1
+      - image: circleci/python:3.6.8
 
     steps:
       - checkout

CMakeLists.txt

@@ -18,11 +18,15 @@ SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
 SET(CMAKE_C_STANDARD 99)
 
 FIND_LIBRARY(TF_LIBRARIES NAMES tensorflow libtensorflow.so)
-
 IF (NOT TF_LIBRARIES)
     MESSAGE(FATAL_ERROR "Could not find tensorflow")
 ENDIF()
 
+FIND_LIBRARY(ORT_LIBRARIES NAMES onnxruntime)
+IF (NOT ORT_LIBRARIES)
+    MESSAGE(FATAL_ERROR "Could not find ONNXRuntime")
+ENDIF()
+
 INCLUDE_DIRECTORIES(${depsAbs}/libtensorflow/include)
 
 IF (APPLE)
@@ -41,7 +45,7 @@ ADD_DEFINITIONS(-DREDISMODULE_EXPERIMENTAL_API)
 ADD_SUBDIRECTORY(util/libtorch_c)
 ADD_SUBDIRECTORY(src)
 ADD_LIBRARY(redisai SHARED $<TARGET_OBJECTS:redisai_obj>)
-TARGET_LINK_LIBRARIES(redisai torch_c ${TF_LIBRARIES} ${platDeps})
+TARGET_LINK_LIBRARIES(redisai ${ORT_LIBRARIES} torch_c ${TF_LIBRARIES} ${platDeps})
 
 SET_TARGET_PROPERTIES(redisai PROPERTIES PREFIX "")
 SET_TARGET_PROPERTIES(redisai PROPERTIES SUFFIX ".so")

README.md

@@ -46,7 +46,7 @@ redis-cli
 
 ## Building
 This will checkout and build and download the libraries for the backends
-(TensorFlow and PyTorch) for your platform.
+(TensorFlow, PyTorch, ONNXRuntime) for your platform.
 
 ```sh
 bash get_deps.sh
@@ -89,15 +89,14 @@ Some languages have client libraries that provide support for RedisAI's commands
 | JRedisAI | Java | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/JRedisAI) |
 | redisai-py | Python | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisai-py) |
 
-
 ## Backend Dependancy
 
-RedisAI currently supports PyTorch (libtorch) and Tensorflow (libtensorflow) as backends. We are also building support for ONNXRuntime backend soon. 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.
+RedisAI currently supports PyTorch (libtorch), Tensorflow (libtensorflow) 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.
 
 
 | RedisAI | PyTorch | TensorFlow | ONNXRuntime   |
 |:--------|:-------:|:----------:|:-------------:|
-| 0.1.0   | 1.0.1   | 1.12.0     | Not Yet       |
+| 0.1.0   | 1.0.1   | 1.12.0     | 0.4.0         |
 
 
 ## Documentation

docs/commands.md

@@ -61,7 +61,7 @@ AI.MODELSET model_key backend device [INPUTS name1 name2 ... OUTPUTS name1 name2
 ```
 
 * model_key - Key for storing the model
-* backend - The backend corresponding to the model being set. Allowed values: `TF`, `TORCH`.
+* backend - The backend corresponding to the model being set. Allowed values: `TF`, `TORCH`, `ONNX`.
 * device - Device where the model is loaded and where the computation will run. Allowed values: `CPU`, `GPU`.
 * INPUTS name1 name2 ... - Name of the nodes in the provided graph corresponding to inputs [`TF` backend only]
 * OUTPUTS name1 name2 ... - Name of the nodes in the provided graph corresponding to outputs [`TF` backend only]
@@ -77,6 +77,10 @@ AI.MODELSET resnet18 TORCH GPU < foo.pt
 AI.MODELSET resnet18 TF CPU INPUTS in1 OUTPUTS linear4 < foo.pt
 ```
 
+```sql
+AI.MODELSET mnist_net ONNX CPU < mnist.onnx
+```
+
 ## AI.MODELGET
 
 Get a model.

examples/models/linear_iris.onnx

@@ -0,0 +1,26 @@
+REDIS_CLI=redis-cli
+
+echo "SET MODEL"
+$REDIS_CLI -x AI.MODELSET foo ONNX CPU < mnist.onnx
+# $REDIS_CLI AI.MODELGET foo
+
+echo "SET TENSORS"
+$REDIS_CLI -x AI.TENSORSET a FLOAT 1 1 28 28 BLOB < one.raw
+
+echo "GET TENSORS"
+$REDIS_CLI AI.TENSORGET a META
+
+echo "RUN MODEL"
+$REDIS_CLI AI.MODELRUN foo INPUTS a OUTPUTS b
+
+echo "GET TENSOR META"
+$REDIS_CLI AI.TENSORGET b META
+
+echo "GET TENSOR VALUES"
+$REDIS_CLI AI.TENSORGET b VALUES
+
+echo "GET TENSOR BLOB"
+# $REDIS_CLI --raw AI.TENSORGET b BLOB
+$REDIS_CLI AI.TENSORGET b BLOB
+
+$REDIS_CLI DEL foo a b

examples/models/load_onnx_model.sh

@@ -0,0 +1,55 @@
+REDIS_CLI=redis-cli
+
+echo "SET MODEL"
+$REDIS_CLI -x AI.MODELSET foo ONNX CPU < logreg_iris.onnx
+# $REDIS_CLI AI.MODELGET foo
+
+echo "SET TENSORS"
+$REDIS_CLI AI.TENSORSET a FLOAT 1 4
+
+echo "GET TENSORS"
+$REDIS_CLI AI.TENSORGET a META
+
+echo "RUN MODEL"
+$REDIS_CLI AI.MODELRUN foo INPUTS a OUTPUTS b c
+
+echo "GET TENSOR META"
+$REDIS_CLI AI.TENSORGET b META
+
+echo "GET TENSOR VALUES"
+$REDIS_CLI AI.TENSORGET b VALUES
+
+echo "GET TENSOR VALUES"
+$REDIS_CLI AI.TENSORGET c VALUES
+
+echo "GET TENSOR BLOB"
+# $REDIS_CLI --raw AI.TENSORGET b BLOB
+$REDIS_CLI AI.TENSORGET b BLOB
+
+$REDIS_CLI DEL foo a b
+
+
+echo "SET MODEL"
+$REDIS_CLI -x AI.MODELSET foo ONNX CPU < linear_iris.onnx
+# $REDIS_CLI AI.MODELGET foo
+
+echo "SET TENSORS"
+$REDIS_CLI AI.TENSORSET a FLOAT 1 4
+
+echo "GET TENSORS"
+$REDIS_CLI AI.TENSORGET a META
+
+echo "RUN MODEL"
+$REDIS_CLI AI.MODELRUN foo INPUTS a OUTPUTS b
+
+echo "GET TENSOR META"
+$REDIS_CLI AI.TENSORGET b META
+
+echo "GET TENSOR VALUES"
+$REDIS_CLI AI.TENSORGET b VALUES
+
+echo "GET TENSOR BLOB"
+# $REDIS_CLI --raw AI.TENSORGET b BLOB
+$REDIS_CLI AI.TENSORGET b BLOB
+
+$REDIS_CLI DEL foo a b

examples/models/load_onnxml_model.sh

@@ -1,8 +1,8 @@
-REDIS_CLI=../../deps/redis/src/redis-cli
+REDIS_CLI=redis-cli
 
 echo "SET MODEL"
 $REDIS_CLI -x AI.MODELSET foo TF GPU INPUTS a b OUTPUTS mul < graph.pb
-$REDIS_CLI AI.MODELGET foo
+#$REDIS_CLI AI.MODELGET foo
 
 echo "SET TENSORS"
 $REDIS_CLI AI.TENSORSET a FLOAT 2 VALUES 2 3

examples/models/load_model.sh examples/models/load_tf_model.shexamples/models/load_model.sh renamed to examples/models/load_tf_model.sh

@@ -1,4 +1,4 @@
-REDIS_CLI=../../deps/redis/src/redis-cli
+REDIS_CLI=redis-cli
 
 echo "SET MODEL"
 $REDIS_CLI -x AI.MODELSET foo TORCH CPU < pt-minimal.pt

examples/models/load_torch_model.sh

@@ -1,4 +1,4 @@
-REDIS_CLI=../../deps/redis/src/redis-cli
+REDIS_CLI=redis-cli
 
 MODEL_FILE=tiny-yolo-voc.pb
 INPUT_VAR=input