Merge pull request #580 from RedisAI/backend_version

Backend version

Author: DvirDukhan

docs/commands.md

@@ -660,14 +660,14 @@ Because `AI.DAGRUN` provides the `PERSIST` option it is flagged as a 'write' com
     Refer to the Redis [`READONLY` command](https://redis.io/commands/readonly) for further information about read-only cluster replicas.
 
 ## AI.INFO
-The **`AI.INFO`** command returns information about the execution a model or a script.
+The **`AI.INFO`** command returns general module information or information about the execution a model or a script.
 
 Runtime information is collected each time that [`AI.MODELRUN`](#aimodelrun) or [`AI.SCRIPTRUN`](#aiscriptrun) is called. The information is stored locally by the executing RedisAI engine, so when deployed in a cluster each shard stores its own runtime information.
 
 **Redis API**
 
 ```
-AI.INFO <key> [RESETSTAT]
+AI.INFO [<key>] [RESETSTAT]
 ```
 
 _Arguments_
@@ -677,7 +677,15 @@ _Arguments_
 
 _Return_
 
-An array with alternating entries that represent the following key-value pairs:
+For a module genernal information: An array with alternating entries that represent the following key-value pairs:
+
+* **Version**: a string showing the current module version.
+* **Low level API Version**:  a string showing the current module's low level api version.
+* **RDB Encoding version**: a string showing the current module's RDB encoding version.
+* **TensorFlow version**: a string showing the current loaded TesnorFlow backend version.
+* **ONNX version**: a string showing the current loaded ONNX Runtime backend version.
+
+For model or script runtime information: An array with alternating entries that represent the following key-value pairs:
 
 * **KEY**: a String of the name of the key storing the model or script value
 * **TYPE**: a String of the type of value (i.e. 'MODEL' or 'SCRIPT')

src/backends.c

@@ -132,6 +132,17 @@ int RAI_LoadBackend_TensorFlow(RedisModuleCtx *ctx, const char *path) {
         return REDISMODULE_ERR;
     }
 
+    backend.get_version =
+        (const char *(*)(void))(unsigned long)dlsym(handle, "RAI_GetBackendVersionTF");
+    if (backend.get_version == NULL) {
+        dlclose(handle);
+        RedisModule_Log(ctx, "warning",
+                        "Backend does not export RAI_GetBackendVersionTF. TF backend "
+                        "not loaded from %s",
+                        path);
+        return REDISMODULE_ERR;
+    }
+
     RAI_backends.tf = backend;
 
     RedisModule_Log(ctx, "notice", "TF backend loaded from %s", path);
@@ -213,6 +224,17 @@ int RAI_LoadBackend_TFLite(RedisModuleCtx *ctx, const char *path) {
         return REDISMODULE_ERR;
     }
 
+    backend.get_version =
+        (const char *(*)(void))(unsigned long)dlsym(handle, "RAI_GetBackendVersionTFLite");
+    if (backend.get_version == NULL) {
+        dlclose(handle);
+        RedisModule_Log(ctx, "warning",
+                        "Backend does not export RAI_GetBackendVersionTFLite. TFLite backend "
+                        "not loaded from %s",
+                        path);
+        return REDISMODULE_ERR;
+    }
+
     RAI_backends.tflite = backend;
 
     RedisModule_Log(ctx, "notice", "TFLITE backend loaded from %s", path);
@@ -327,6 +349,17 @@ int RAI_LoadBackend_Torch(RedisModuleCtx *ctx, const char *path) {
         return REDISMODULE_ERR;
     }
 
+    backend.get_version =
+        (const char *(*)(void))(unsigned long)dlsym(handle, "RAI_GetBackendVersionTorch");
+    if (backend.get_version == NULL) {
+        dlclose(handle);
+        RedisModule_Log(ctx, "warning",
+                        "Backend does not export RAI_GetBackendVersionTorch. TORCH backend "
+                        "not loaded from %s",
+                        path);
+        return REDISMODULE_ERR;
+    }
+
     RAI_backends.torch = backend;
 
     RedisModule_Log(ctx, "notice", "TORCH backend loaded from %s", path);
@@ -407,6 +440,17 @@ int RAI_LoadBackend_ONNXRuntime(RedisModuleCtx *ctx, const char *path) {
         return REDISMODULE_ERR;
     }
 
+    backend.get_version =
+        (const char *(*)(void))(unsigned long)dlsym(handle, "RAI_GetBackendVersionORT");
+    if (backend.get_version == NULL) {
+        dlclose(handle);
+        RedisModule_Log(ctx, "warning",
+                        "Backend does not export RAI_GetBackendVersionORT. ONNX backend "
+                        "not loaded from %s",
+                        path);
+        return REDISMODULE_ERR;
+    }
+
     RAI_backends.onnx = backend;
 
     RedisModule_Log(ctx, "notice", "ONNX backend loaded from %s", path);

src/backends.h

@@ -74,6 +74,9 @@ typedef struct RAI_LoadedBackend {
     // RAI_ScriptRunCtx pointer
     int (*script_run)(RAI_ScriptRunCtx *, RAI_Error *);
 
+    // Returns the backend version.
+    const char *(*get_version)(void);
+
 } RAI_LoadedBackend;
 
 typedef struct RAI_LoadedBackends {

src/backends/onnxruntime.c

@@ -670,3 +670,5 @@ int RAI_ModelSerializeORT(RAI_Model *model, char **buffer, size_t *len, RAI_Erro
 
     return 0;
 }
+
+const char *RAI_GetBackendVersionORT(void) { return OrtGetApiBase()->GetVersionString(); }

src/backends/onnxruntime.h

@@ -17,4 +17,6 @@ int RAI_ModelRunORT(RAI_ModelRunCtx **mctxs, RAI_Error *error);
 
 int RAI_ModelSerializeORT(RAI_Model *model, char **buffer, size_t *len, RAI_Error *error);
 
+const char *RAI_GetBackendVersionORT(void);
+
 #endif /* SRC_BACKENDS_ONNXRUNTIME_H_ */

src/backends/tensorflow.c

@@ -591,3 +591,5 @@ int RAI_ModelSerializeTF(RAI_Model *model, char **buffer, size_t *len, RAI_Error
 
     return 0;
 }
+
+const char *RAI_GetBackendVersionTF(void) { return TF_Version(); }

src/backends/tensorflow.h

@@ -19,4 +19,6 @@ int RAI_ModelRunTF(RAI_ModelRunCtx **mctxs, RAI_Error *error);
 
 int RAI_ModelSerializeTF(RAI_Model *model, char **buffer, size_t *len, RAI_Error *error);
 
+const char *RAI_GetBackendVersionTF(void);
+
 #endif /* SRC_BACKENDS_TENSORFLOW_H_ */

src/backends/tflite.c

@@ -237,3 +237,5 @@ int RAI_ModelSerializeTFLite(RAI_Model *model, char **buffer, size_t *len, RAI_E
 
     return 0;
 }
+
+const char *RAI_GetBackendVersionTFLite(void) { return "NA"; }

src/backends/tflite.h

@@ -1,5 +1,4 @@
-#ifndef SRC_BACKENDS_TFLITE_H_
-#define SRC_BACKENDS_TFLITE_H_
+#pragma once
 
 #include "config.h"
 #include "tensor_struct.h"
@@ -17,4 +16,4 @@ int RAI_ModelRunTFLite(RAI_ModelRunCtx **mctxs, RAI_Error *error);
 
 int RAI_ModelSerializeTFLite(RAI_Model *model, char **buffer, size_t *len, RAI_Error *error);
 
-#endif /* SRC_BACKENDS_TFLITE_H_ */
+const char *RAI_GetBackendVersionTFLite(void);

src/backends/torch.c

@@ -367,3 +367,5 @@ int RAI_ScriptRunTorch(RAI_ScriptRunCtx *sctx, RAI_Error *error) {
 
     return 0;
 }
+
+const char *RAI_GetBackendVersionTorch(void) { return "NA"; }