add command reference

Author: zhao-lang

.github/workflows/rust.yml

@@ -23,4 +23,4 @@ jobs:
         # Artifact name
         name: build-release
         # Directory containing files to upload
-        path: target/release
+        path: target/release/libredis_hnsw.so

.gitignore

@@ -13,3 +13,4 @@ Cargo.lock
 /.vscode
 
 *.rdb
+*.aof

Readme.md

@@ -1,6 +1,6 @@
 # HNSW for Redis
 
-`redis_hnsw` is a Hierarchical Navigable Small World (HNSW) implementation for Redis.
+`redis_hnsw` is a Hierarchical Navigable Small World (HNSW) implementation for Redis. Based on the paper [Efficient and robust approximate nearest neighbor search using Hierarchical Navigable Small World graphs](https://arxiv.org/abs/1603.09320). Currently only supports Euclidean distance, Hamming distance forthcoming.
 
 ## Getting Started
 
@@ -16,3 +16,141 @@ Add nodes - `hnsw.node.add <index_name> <node_name> <...data>`
 Delete nodes - `hnsw.node.del <index_name> <node_name>`
 
 Search KNN - `hnsw.search <index_name> <k> <..data>`
+
+
+## Command Reference
+
+### HNSW.NEW
+#### Format
+```
+HNSW.NEW {index} [DATA_DIM] [M] [EF_CONSTRUCTION]
+```
+#### Description
+Creates an HNSW index 
+#### Example
+```
+HNSW.NEW foo 128 5 200
+```
+#### Parameters
+* **index**: name of the new index.
+* **DATA_DIM**: dimensionality of the data.
+* **M**: algorithm parameter for the number of neighbors to select for each node.
+* **EF_CONSTRUCTION**: algorithm parameter for the size of the dynamic candidate list.
+#### Complexity
+O(1)
+#### Returns
+OK or an error
+
+### HNSW.GET
+#### Format
+```
+HNSW.GET {index}
+```
+#### Description
+Retrieves an HNSW index 
+#### Example
+```
+HNSW.GET foo
+```
+#### Parameters
+* **index**: name of the index.
+#### Complexity
+O(1)
+#### Returns
+**Array Reply** key-value pairs of index attributes
+
+### HNSW.DEL
+#### Format
+```
+HNSW.DEL {index}
+```
+#### Description
+Deletes an HNSW index 
+#### Example
+```
+HNSW.DEL foo
+```
+#### Parameters
+* **index**: name of the index.
+#### Complexity
+O(1)
+#### Returns
+OK or an error
+
+### HNSW.NODE.ADD
+#### Format
+```
+HNSW.NODE.ADD {index} {node} {...DATA}
+```
+#### Description
+Adds an element to the index 
+#### Example
+```
+HNSW.NODE.ADD foo bar 1.0 1.0 1.0 1.0
+```
+#### Parameters
+* **index**: name of the index
+* **node**: name of the new node
+* **DATA**: space separated vector of data. Total entries must match `DATA_DIM` of index
+#### Complexity
+O(log(n)) where n is the number of nodes in the index
+#### Returns
+OK or an error
+
+### HNSW.NODE.GET
+#### Format
+```
+HNSW.NODE.GET {index} {node}
+```
+#### Description
+Retrieves an element from the index 
+#### Example
+```
+HNSW.NODE.GET foo bar
+```
+#### Parameters
+* **index**: name of the index
+* **node**: name of the node
+#### Complexity
+O(1)
+#### Returns
+**Array Reply** key-value pairs of node attributes
+
+### HNSW.NODE.DEL
+#### Format
+```
+HNSW.NODE.DEL {index} {node}
+```
+#### Description
+Removes an element from the index 
+#### Example
+```
+HNSW.NODE.DEL foo bar
+```
+#### Parameters
+* **index**: name of the index
+* **node**: name of the node
+#### Complexity
+O(log(n)) where n is the number of nodes in the index
+#### Returns
+OK or an error
+
+### HNSW.SEARCH
+#### Format
+```
+HNSW.SEARCH {index} {K} {...DATA}
+```
+#### Description
+Search the index for the K nearest elements to the query
+#### Example
+```
+HNSW.SEARCH foo 5 0.0 0.0 0.0 0.0
+```
+#### Parameters
+* **index**: name of the index
+* **K**: number of nearest neighbors to return
+* **DATA**: space separated vector of query data. Total entries must match `DATA_DIM` of index
+#### Complexity
+O(log(n)) where n is the number of nodes in the index
+#### Returns
+**Array Reply** where the first element is the number of results, followed by key-value pairs of similiarity and returned node key.

cmd.sh

@@ -1,17 +1,22 @@
-# redis-cli hnsw.new test1 128 5
+redis-cli hnsw.new test1 128 5
 
-# for i in {1..100}
-# do
-# data=$(printf "${i} %.0s" {1..128})
-# redis-cli hnsw.node.add test1 node${i-1} ${data}
-# done
+for i in {1..100}
+do
+data=$(printf "${i} %.0s" {1..128})
+redis-cli hnsw.node.add test1 node${i-1} ${data}
+done
 
-data=$(printf "50 %.0s" {1..128})
+redis-cli bgsave
+
+redis-cli hnsw.get test1
+redis-cli hnsw.node.get test1 node1
+
+data=$(printf "2 %.0s" {1..128})
 redis-cli hnsw.search test1 5 ${data}
 
-# for i in {1..100}
-# do
-# redis-cli hnsw.node.del test1 node${i-1}
-# done
+for i in {1..100}
+do
+redis-cli hnsw.node.del test1 node${i-1}
+done
 
-# redis-cli hnsw.del test1
+redis-cli hnsw.del test1

src/hnsw/hnsw.rs

@@ -864,7 +864,11 @@ impl Index {
             let c = w.pop().unwrap();
             let cr = c.read();
             let cnr = cr.node.read();
-            res.push(SearchResult::new(cr.sim, &cnr.name, &cnr.data));
+            res.push(SearchResult::new(
+                cr.sim,
+                (&cnr.name).split(".").collect::<Vec<&str>>()[2],
+                &cnr.data,
+            ));
         }
         res
     }

src/types.rs

@@ -417,7 +417,7 @@ impl SearchResultRedis {
     pub fn as_redisvalue(&self) -> RedisValue {
         let mut reply: Vec<RedisValue> = Vec::new();
 
-        reply.push("sim".into());
+        reply.push("similarity".into());
         reply.push(self.sim.into());
 
         reply.push("name".into());