From 8b4bde19b45bbba7a42852f6f763d9d2df107c77 Mon Sep 17 00:00:00 2001 From: antirez Date: Sun, 9 Feb 2025 09:53:09 +0100 Subject: [PATCH] README: some rephrasing. --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1a1a7992dc..32dfba3654 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -This module implements vector sets for Redis, a new Redis data type similar -to sorted sets but having a vector instead of a score. It is possible to -add items and then get them back by similiarity to either a user-provided -vector or a vector of an element already inserted. +This module implements Vector Sets for Redis, a new Redis data type similar +to Sorted Sets but having string elements associated to a vector instead of +a score. The fundamental goal of Vector Sets is to make possible adding items, +and later get a subset of the added items that are the most similar to a +specified vector (often a learned embedding) of the most similar to the vector +of an element that is already part of the Vector Set. ## Installation +Buil with: + make Then load the module with the following command line, or by inserting the needed directives in the `redis.conf` file. @@ -19,7 +23,7 @@ The execute the tests with: ./test.py -## Commands +## Reference of available commands **VADD: add items into a vector set**