Skip to content

refactor: Nested search params in ES config #120

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
merged 7 commits into from
Apr 15, 2024
Merged

refactor: Nested search params in ES config #120

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bf3f9eb
refactor: Nested search params in ES config
KShivendu Apr 11, 2024
2d40ab1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 11, 2024
31a867c
fix: Remove extra config vars
KShivendu Apr 12, 2024
a7fe285
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 12, 2024
b176179
Merge branch 'master' into refactor/es-client
KShivendu Apr 15, 2024
5a20558
fix: Remove extra comment
KShivendu Apr 15, 2024
c527ae3
feat: Add keyword, text, and float index types in ES
KShivendu Apr 15, 2024
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
28 changes: 24 additions & 4 deletions engine/clients/elasticsearch/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
ELASTIC_PORT = 9200
ELASTIC_INDEX = "bench"
ELASTIC_USER = "elastic"
ELASTIC_PASSWORD = "passwd"
import os

from elasticsearch import Elasticsearch

ELASTIC_PORT = int(os.getenv("ELASTIC_PORT", 9200))
ELASTIC_INDEX = os.getenv("ELASTIC_INDEX", "bench")
ELASTIC_USER = os.getenv("ELASTIC_USER", "elastic")
ELASTIC_PASSWORD = os.getenv("ELASTIC_PASSWORD", "passwd")


def get_es_client(host, connection_params):
init_params = {
"verify_certs": False,
"retry_on_timeout": True,
"ssl_show_warn": False,
**connection_params,
}
client = Elasticsearch(
f"http://{host}:{ELASTIC_PORT}",
basic_auth=(ELASTIC_USER, ELASTIC_PASSWORD),
**init_params,
)
assert client.ping()
return client
32 changes: 6 additions & 26 deletions engine/clients/elasticsearch/configure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,7 @@
from engine.base_client import IncompatibilityError
from engine.base_client.configure import BaseConfigurator
from engine.base_client.distances import Distance
from engine.clients.elasticsearch.config import (
ELASTIC_INDEX,
ELASTIC_PASSWORD,
ELASTIC_PORT,
ELASTIC_USER,
)
from engine.clients.elasticsearch.config import ELASTIC_INDEX, get_es_client


class ElasticConfigurator(BaseConfigurator):
Expand All @@ -18,26 +13,15 @@ class ElasticConfigurator(BaseConfigurator):
Distance.COSINE: "cosine",
Distance.DOT: "dot_product",
}
# TODO: Add other types
INDEX_TYPE_MAPPING = {
"int": "long",
"geo": "geo_point",
}

def __init__(self, host, collection_params: dict, connection_params: dict):
super().__init__(host, collection_params, connection_params)
init_params = {
**{
"verify_certs": False,
"request_timeout": 90,
"retry_on_timeout": True,
},
**connection_params,
}
self.client = Elasticsearch(
f"http://{host}:{ELASTIC_PORT}",
basic_auth=(ELASTIC_USER, ELASTIC_PASSWORD),
**init_params,
)
self.client = get_es_client(host, connection_params)

def clean(self):
try:
Expand All @@ -60,7 +44,7 @@ def recreate(self, dataset: Dataset, collection_params):
"index": {
"number_of_shards": 1,
"number_of_replicas": 0,
"refresh_interval": -1,
"refresh_interval": -1, # no refresh is required because we index all the data at once
}
},
mappings={
Expand All @@ -72,12 +56,8 @@ def recreate(self, dataset: Dataset, collection_params):
"index": True,
"similarity": self.DISTANCE_MAPPING[dataset.config.distance],
"index_options": {
**{
"type": "hnsw",
"m": 16,
"ef_construction": 100,
},
**collection_params.get("index_options"),
"type": "hnsw",
**collection_params["index_options"],
},
},
**self._prepare_fields_config(dataset),
Expand Down
25 changes: 4 additions & 21 deletions engine/clients/elasticsearch/search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@
from elasticsearch import Elasticsearch

from engine.base_client.search import BaseSearcher
from engine.clients.elasticsearch.config import (
ELASTIC_INDEX,
ELASTIC_PASSWORD,
ELASTIC_PORT,
ELASTIC_USER,
)
from engine.clients.elasticsearch.config import ELASTIC_INDEX, get_es_client
from engine.clients.elasticsearch.parser import ElasticConditionParser


Expand All @@ -29,20 +24,8 @@ def get_mp_start_method(cls):
return "forkserver" if "forkserver" in mp.get_all_start_methods() else "spawn"

@classmethod
def init_client(cls, host, distance, connection_params: dict, search_params: dict):
init_params = {
**{
"verify_certs": False,
"request_timeout": 90,
"retry_on_timeout": True,
},
**connection_params,
}
cls.client: Elasticsearch = Elasticsearch(
f"http://{host}:{ELASTIC_PORT}",
basic_auth=(ELASTIC_USER, ELASTIC_PASSWORD),
**init_params,
)
def init_client(cls, host, _distance, connection_params: dict, search_params: dict):
cls.client = get_es_client(host, connection_params)
cls.search_params = search_params

@classmethod
Expand All @@ -51,7 +34,7 @@ def search_one(cls, vector, meta_conditions, top) -> List[Tuple[int, float]]:
"field": "vector",
"query_vector": vector,
"k": top,
**{"num_candidates": 100, **cls.search_params},
**cls.search_params["params"],
}

meta_conditions = cls.parser.parse(meta_conditions)
Expand Down
23 changes: 3 additions & 20 deletions engine/clients/elasticsearch/upload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@
from elasticsearch import Elasticsearch

from engine.base_client.upload import BaseUploader
from engine.clients.elasticsearch.config import (
ELASTIC_INDEX,
ELASTIC_PASSWORD,
ELASTIC_PORT,
ELASTIC_USER,
)
from engine.clients.elasticsearch.config import ELASTIC_INDEX, get_es_client


class ClosableElastic(Elasticsearch):
Expand All @@ -27,20 +22,8 @@ def get_mp_start_method(cls):
return "forkserver" if "forkserver" in mp.get_all_start_methods() else "spawn"

@classmethod
def init_client(cls, host, distance, connection_params, upload_params):
init_params = {
**{
"verify_certs": False,
"request_timeout": 90,
"retry_on_timeout": True,
},
**connection_params,
}
cls.client = Elasticsearch(
f"http://{host}:{ELASTIC_PORT}",
basic_auth=(ELASTIC_USER, ELASTIC_PASSWORD),
**init_params,
)
def init_client(cls, host, _distance, connection_params, upload_params):
cls.client = get_es_client(host, connection_params)
cls.upload_params = upload_params

@classmethod
Expand Down
28 changes: 14 additions & 14 deletions experiments/configurations/elasticsearch-single-node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
},
"collection_params": { "index_options": { "m": 16, "ef_construction": 100 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
},
Expand All @@ -20,8 +20,8 @@
},
"collection_params": { "index_options": { "m": 16, "ef_construction": 128 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
},
Expand All @@ -33,8 +33,8 @@
},
"collection_params": { "index_options": { "m": 32, "ef_construction": 128 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
},
Expand All @@ -46,8 +46,8 @@
},
"collection_params": { "index_options": { "m": 32, "ef_construction": 256 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
},
Expand All @@ -59,8 +59,8 @@
},
"collection_params": { "index_options": { "m": 32, "ef_construction": 512 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
},
Expand All @@ -72,8 +72,8 @@
},
"collection_params": { "index_options": { "m": 64, "ef_construction": 256 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
},
Expand All @@ -85,8 +85,8 @@
},
"collection_params": { "index_options": { "m": 64, "ef_construction": 512 } },
"search_params": [
{ "parallel": 1, "num_candidates": 128 }, { "parallel": 1, "num_candidates": 256 }, { "parallel": 1, "num_candidates": 512 },
{ "parallel": 100, "num_candidates": 128 }, { "parallel": 100, "num_candidates": 256 }, { "parallel": 100, "num_candidates": 512 }
{ "parallel": 1, "params": {"num_candidates": 128} }, { "parallel": 1, "params": {"num_candidates": 256} }, { "parallel": 1, "params" :{"num_candidates": 512} },
{ "parallel": 100, "params": {"num_candidates": 128} }, { "parallel": 100, "params": {"num_candidates": 256} }, { "parallel": 100, "params" :{"num_candidates": 512} }
],
"upload_params": { "parallel": 16 }
}
Expand Down