Skip to content

fix: keep redis default values for vector similarity parameters #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alaeddine-13 merged 2 commits into from
Sep 23, 2022
Merged

fix: keep redis default values for vector similarity parameters #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8518b4e
fix: do not alter redis default configuration
alaeddine-13 Sep 23, 2022
8449d01
docs: update param docs
alaeddine-13 Sep 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docarray/array/storage/redis/backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import numpy as np
from docarray import Document
from docarray.array.storage.base.backend import BaseBackendMixin, TypeMap
from docarray.helper import dataclass_from_dict, random_identity
from docarray.helper import dataclass_from_dict, random_identity, filter_dict

from redis import Redis
from redis.commands.search.field import NumericField, TextField, VectorField
Expand All @@ -28,10 +28,10 @@ class RedisConfig:
tag_indices: List[str] = field(default_factory=list)
batch_size: int = field(default=64)
method: str = field(default='HNSW')
ef_construction: int = field(default=200)
m: int = field(default=16)
ef_runtime: int = field(default=10)
block_size: int = field(default=1048576)
ef_construction: Optional[int] = None
m: Optional[int] = None
ef_runtime: Optional[int] = None
block_size: Optional[int] = None
initial_cap: Optional[int] = None
columns: Optional[Union[List[Tuple[str, str]], Dict[str, str]]] = None

Expand Down Expand Up @@ -137,11 +137,11 @@ def _build_schema_from_redis_config(self):
'EF_CONSTRUCTION': self._config.ef_construction,
'EF_RUNTIME': self._config.ef_runtime,
}
index_param.update(index_options)
index_param.update(filter_dict(index_options))

if self._config.method == 'FLAT':
index_options = {'BLOCK_SIZE': self._config.block_size}
index_param.update(index_options)
index_param.update(filter_dict(index_options))

if self._config.initial_cap:
index_param['INITIAL_CAP'] = self._config.initial_cap
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/document-store/redis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ The following configs can be set:
| `columns` | Other fields to store in Document and build schema | `None` |

You can check the default values in [the docarray source code](https://github.com/jina-ai/docarray/blob/main/docarray/array/storage/redis/backend.py)

For vector search configurations, default values are those of the database backend, you can find them in [redis documentation](https://redis.io/docs/stack/search/reference/vectors/)

```{note}
We will support geo-filtering soon.
Expand Down