vectordb-bench 0.0.19__py3-none-any.whl → 0.0.21__py3-none-any.whl

vectordb_bench/backend/clients/pgdiskann/config.py

@@ -1,7 +1,9 @@
 from abc import abstractmethod
-from typing import Any, Mapping, Optional, Sequence, TypedDict
+from collections.abc import Mapping, Sequence
+from typing import Any, LiteralString, TypedDict
+
 from pydantic import BaseModel, SecretStr
-from typing_extensions import LiteralString
+
 from ..api import DBCaseConfig, DBConfig, IndexType, MetricType
 
 POSTGRE_URL_PLACEHOLDER = "postgresql://%s:%s@%s/%s"
@@ -9,7 +11,7 @@ POSTGRE_URL_PLACEHOLDER = "postgresql://%s:%s@%s/%s"
 
 class PgDiskANNConfigDict(TypedDict):
     """These keys will be directly used as kwargs in psycopg connection string,
-        so the names must match exactly psycopg API"""
+    so the names must match exactly psycopg API"""
 
     user: str
     password: str
@@ -41,44 +43,43 @@ class PgDiskANNIndexConfig(BaseModel, DBCaseConfig):
     metric_type: MetricType | None = None
     create_index_before_load: bool = False
     create_index_after_load: bool = True
-    maintenance_work_mem: Optional[str]
-    max_parallel_workers: Optional[int]
+    maintenance_work_mem: str | None
+    max_parallel_workers: int | None
 
     def parse_metric(self) -> str:
         if self.metric_type == MetricType.L2:
             return "vector_l2_ops"
-        elif self.metric_type == MetricType.IP:
+        if self.metric_type == MetricType.IP:
             return "vector_ip_ops"
         return "vector_cosine_ops"
 
     def parse_metric_fun_op(self) -> LiteralString:
         if self.metric_type == MetricType.L2:
             return "<->"
-        elif self.metric_type == MetricType.IP:
+        if self.metric_type == MetricType.IP:
             return "<#>"
         return "<=>"
 
     def parse_metric_fun_str(self) -> str:
         if self.metric_type == MetricType.L2:
             return "l2_distance"
-        elif self.metric_type == MetricType.IP:
+        if self.metric_type == MetricType.IP:
             return "max_inner_product"
         return "cosine_distance"
-    
+
     @abstractmethod
-    def index_param(self) -> dict:
-        ...
+    def index_param(self) -> dict: ...
 
     @abstractmethod
-    def search_param(self) -> dict:
-        ...
+    def search_param(self) -> dict: ...
 
     @abstractmethod
-    def session_param(self) -> dict:
-        ...
+    def session_param(self) -> dict: ...
 
     @staticmethod
-    def _optionally_build_with_options(with_options: Mapping[str, Any]) -> Sequence[dict[str, Any]]:
+    def _optionally_build_with_options(
+        with_options: Mapping[str, Any],
+    ) -> Sequence[dict[str, Any]]:
         """Walk through mappings, creating a List of {key1 = value} pairs. That will be used to build a where clause"""
         options = []
         for option_name, value in with_options.items():
@@ -87,35 +88,36 @@ class PgDiskANNIndexConfig(BaseModel, DBCaseConfig):
                     {
                         "option_name": option_name,
                         "val": str(value),
-                    }
+                    },
                 )
         return options
 
     @staticmethod
     def _optionally_build_set_options(
-        set_mapping: Mapping[str, Any]
+        set_mapping: Mapping[str, Any],
     ) -> Sequence[dict[str, Any]]:
         """Walk through options, creating 'SET 'key1 = "value1";' list"""
         session_options = []
         for setting_name, value in set_mapping.items():
             if value:
                 session_options.append(
-                    {"parameter": {
+                    {
+                        "parameter": {
                             "setting_name": setting_name,
                             "val": str(value),
                         },
-                    }
+                    },
                 )
         return session_options
-    
+
 
 class PgDiskANNImplConfig(PgDiskANNIndexConfig):
     index: IndexType = IndexType.DISKANN
     max_neighbors: int | None
     l_value_ib: int | None
     l_value_is: float | None
-    maintenance_work_mem: Optional[str] = None
-    max_parallel_workers: Optional[int] = None
+    maintenance_work_mem: str | None = None
+    max_parallel_workers: int | None = None
 
     def index_param(self) -> dict:
         return {
@@ -128,18 +130,19 @@ class PgDiskANNImplConfig(PgDiskANNIndexConfig):
             "maintenance_work_mem": self.maintenance_work_mem,
             "max_parallel_workers": self.max_parallel_workers,
         }
-    
+
     def search_param(self) -> dict:
         return {
             "metric": self.parse_metric(),
             "metric_fun_op": self.parse_metric_fun_op(),
         }
-    
+
     def session_param(self) -> dict:
         return {
             "diskann.l_value_is": self.l_value_is,
         }
-    
+
+
 _pgdiskann_case_config = {
     IndexType.DISKANN: PgDiskANNImplConfig,
 }

vectordb_bench/backend/clients/pgdiskann/pgdiskann.py

@@ -1,9 +1,9 @@
 """Wrapper around the pg_diskann vector database over VectorDB"""
 
 import logging
-import pprint
+from collections.abc import Generator
 from contextlib import contextmanager
-from typing import Any, Generator, Optional, Tuple
+from typing import Any
 
 import numpy as np
 import psycopg
@@ -44,20 +44,21 @@ class PgDiskANN(VectorDB):
         self._primary_field = "id"
         self._vector_field = "embedding"
 
-        self.conn, self.cursor = self._create_connection(**self.db_config)        
+        self.conn, self.cursor = self._create_connection(**self.db_config)
 
         log.info(f"{self.name} config values: {self.db_config}\n{self.case_config}")
         if not any(
             (
                 self.case_config.create_index_before_load,
                 self.case_config.create_index_after_load,
-            )
+            ),
         ):
-            err = f"{self.name} config must create an index using create_index_before_load or create_index_after_load"
-            log.error(err)
-            raise RuntimeError(
-                f"{err}\n{pprint.pformat(self.db_config)}\n{pprint.pformat(self.case_config)}"
+            msg = (
+                f"{self.name} config must create an index using create_index_before_load or create_index_after_load"
+                f"{self.name} config values: {self.db_config}\n{self.case_config}"
             )
+            log.error(msg)
+            raise RuntimeError(msg)
 
         if drop_old:
             self._drop_index()
@@ -72,7 +73,7 @@ class PgDiskANN(VectorDB):
         self.conn = None
 
     @staticmethod
-    def _create_connection(**kwargs) -> Tuple[Connection, Cursor]:
+    def _create_connection(**kwargs) -> tuple[Connection, Cursor]:
         conn = psycopg.connect(**kwargs)
         conn.cursor().execute("CREATE EXTENSION IF NOT EXISTS pg_diskann CASCADE")
         conn.commit()
@@ -101,25 +102,25 @@ class PgDiskANN(VectorDB):
                 log.debug(command.as_string(self.cursor))
                 self.cursor.execute(command)
             self.conn.commit()
-        
+
         self._filtered_search = sql.Composed(
             [
                 sql.SQL(
-                    "SELECT id FROM public.{table_name} WHERE id >= %s ORDER BY embedding "
-                    ).format(table_name=sql.Identifier(self.table_name)),
+                    "SELECT id FROM public.{table_name} WHERE id >= %s ORDER BY embedding ",
+                ).format(table_name=sql.Identifier(self.table_name)),
                 sql.SQL(self.case_config.search_param()["metric_fun_op"]),
                 sql.SQL(" %s::vector LIMIT %s::int"),
-            ]
+            ],
         )
 
         self._unfiltered_search = sql.Composed(
             [
                 sql.SQL("SELECT id FROM public.{} ORDER BY embedding ").format(
-                    sql.Identifier(self.table_name)
+                    sql.Identifier(self.table_name),
                 ),
                 sql.SQL(self.case_config.search_param()["metric_fun_op"]),
                 sql.SQL(" %s::vector LIMIT %s::int"),
-            ]
+            ],
         )
 
         try:
@@ -137,15 +138,12 @@ class PgDiskANN(VectorDB):
 
         self.cursor.execute(
             sql.SQL("DROP TABLE IF EXISTS public.{table_name}").format(
-                table_name=sql.Identifier(self.table_name)
-            )
+                table_name=sql.Identifier(self.table_name),
+            ),
         )
         self.conn.commit()
 
-    def ready_to_load(self):
-        pass
-
-    def optimize(self):
+    def optimize(self, data_size: int | None = None):
         self._post_insert()
 
     def _post_insert(self):
@@ -160,7 +158,7 @@ class PgDiskANN(VectorDB):
         log.info(f"{self.name} client drop index : {self._index_name}")
 
         drop_index_sql = sql.SQL("DROP INDEX IF EXISTS {index_name}").format(
-            index_name=sql.Identifier(self._index_name)
+            index_name=sql.Identifier(self._index_name),
         )
         log.debug(drop_index_sql.as_string(self.cursor))
         self.cursor.execute(drop_index_sql)
@@ -175,64 +173,53 @@ class PgDiskANN(VectorDB):
         if index_param["maintenance_work_mem"] is not None:
             self.cursor.execute(
                 sql.SQL("SET maintenance_work_mem TO {};").format(
-                    index_param["maintenance_work_mem"]
-                )
+                    index_param["maintenance_work_mem"],
+                ),
             )
             self.cursor.execute(
                 sql.SQL("ALTER USER {} SET maintenance_work_mem TO {};").format(
                     sql.Identifier(self.db_config["user"]),
                     index_param["maintenance_work_mem"],
-                )
+                ),
             )
             self.conn.commit()
 
         if index_param["max_parallel_workers"] is not None:
             self.cursor.execute(
                 sql.SQL("SET max_parallel_maintenance_workers TO '{}';").format(
-                    index_param["max_parallel_workers"]
-                )
+                    index_param["max_parallel_workers"],
+                ),
             )
             self.cursor.execute(
-                sql.SQL(
-                    "ALTER USER {} SET max_parallel_maintenance_workers TO '{}';"
-                ).format(
+                sql.SQL("ALTER USER {} SET max_parallel_maintenance_workers TO '{}';").format(
                     sql.Identifier(self.db_config["user"]),
                     index_param["max_parallel_workers"],
-                )
+                ),
             )
             self.cursor.execute(
                 sql.SQL("SET max_parallel_workers TO '{}';").format(
-                    index_param["max_parallel_workers"]
-                )
+                    index_param["max_parallel_workers"],
+                ),
             )
             self.cursor.execute(
-                sql.SQL(
-                    "ALTER USER {} SET max_parallel_workers TO '{}';"
-                ).format(
+                sql.SQL("ALTER USER {} SET max_parallel_workers TO '{}';").format(
                     sql.Identifier(self.db_config["user"]),
                     index_param["max_parallel_workers"],
-                )
+                ),
             )
             self.cursor.execute(
-                sql.SQL(
-                    "ALTER TABLE {} SET (parallel_workers = {});"
-                ).format(
+                sql.SQL("ALTER TABLE {} SET (parallel_workers = {});").format(
                     sql.Identifier(self.table_name),
                     index_param["max_parallel_workers"],
-                )
+                ),
             )
             self.conn.commit()
 
-        results = self.cursor.execute(
-            sql.SQL("SHOW max_parallel_maintenance_workers;")
-        ).fetchall()
-        results.extend(
-            self.cursor.execute(sql.SQL("SHOW max_parallel_workers;")).fetchall()
-        )
-        results.extend(
-            self.cursor.execute(sql.SQL("SHOW maintenance_work_mem;")).fetchall()
-        )
+        results = self.cursor.execute(sql.SQL("SHOW max_parallel_maintenance_workers;")).fetchall()
+        results.extend(self.cursor.execute(sql.SQL("SHOW max_parallel_workers;")).fetchall())
+        results.extend(self.cursor.execute(sql.SQL("SHOW maintenance_work_mem;")).fetchall())
         log.info(f"{self.name} parallel index creation parameters: {results}")
+
     def _create_index(self):
         assert self.conn is not None, "Connection is not initialized"
         assert self.cursor is not None, "Cursor is not initialized"
@@ -248,28 +235,23 @@ class PgDiskANN(VectorDB):
                     sql.SQL("{option_name} = {val}").format(
                         option_name=sql.Identifier(option_name),
                         val=sql.Identifier(str(option_val)),
-                    )
+                    ),
                 )
-        
-        if any(options):
-            with_clause = sql.SQL("WITH ({});").format(sql.SQL(", ").join(options))
-        else:
-            with_clause = sql.Composed(())
+
+        with_clause = sql.SQL("WITH ({});").format(sql.SQL(", ").join(options)) if any(options) else sql.Composed(())
 
         index_create_sql = sql.SQL(
             """
-            CREATE INDEX IF NOT EXISTS {index_name} ON public.{table_name} 
+            CREATE INDEX IF NOT EXISTS {index_name} ON public.{table_name}
             USING {index_type} (embedding {embedding_metric})
-            """
+            """,
         ).format(
             index_name=sql.Identifier(self._index_name),
             table_name=sql.Identifier(self.table_name),
             index_type=sql.Identifier(index_param["index_type"].lower()),
             embedding_metric=sql.Identifier(index_param["metric"]),
         )
-        index_create_sql_with_with_clause = (
-            index_create_sql + with_clause
-        ).join(" ")
+        index_create_sql_with_with_clause = (index_create_sql + with_clause).join(" ")
         log.debug(index_create_sql_with_with_clause.as_string(self.cursor))
         self.cursor.execute(index_create_sql_with_with_clause)
         self.conn.commit()
@@ -283,14 +265,12 @@ class PgDiskANN(VectorDB):
 
             self.cursor.execute(
                 sql.SQL(
-                    "CREATE TABLE IF NOT EXISTS public.{table_name} (id BIGINT PRIMARY KEY, embedding vector({dim}));"
-                ).format(table_name=sql.Identifier(self.table_name), dim=dim)
+                    "CREATE TABLE IF NOT EXISTS public.{table_name} (id BIGINT PRIMARY KEY, embedding vector({dim}));",
+                ).format(table_name=sql.Identifier(self.table_name), dim=dim),
             )
             self.conn.commit()
         except Exception as e:
-            log.warning(
-                f"Failed to create pgdiskann table: {self.table_name} error: {e}"
-            )
+            log.warning(f"Failed to create pgdiskann table: {self.table_name} error: {e}")
             raise e from None
 
     def insert_embeddings(
@@ -298,7 +278,7 @@ class PgDiskANN(VectorDB):
         embeddings: list[list[float]],
         metadata: list[int],
         **kwargs: Any,
-    ) -> Tuple[int, Optional[Exception]]:
+    ) -> tuple[int, Exception | None]:
         assert self.conn is not None, "Connection is not initialized"
         assert self.cursor is not None, "Cursor is not initialized"
 
@@ -308,8 +288,8 @@ class PgDiskANN(VectorDB):
 
             with self.cursor.copy(
                 sql.SQL("COPY public.{table_name} FROM STDIN (FORMAT BINARY)").format(
-                    table_name=sql.Identifier(self.table_name)
-                )
+                    table_name=sql.Identifier(self.table_name),
+                ),
             ) as copy:
                 copy.set_types(["bigint", "vector"])
                 for i, row in enumerate(metadata_arr):
@@ -321,9 +301,7 @@ class PgDiskANN(VectorDB):
 
             return len(metadata), None
         except Exception as e:
-            log.warning(
-                f"Failed to insert data into table ({self.table_name}), error: {e}"
-            )
+            log.warning(f"Failed to insert data into table ({self.table_name}), error: {e}")
             return 0, e
 
     def search_embedding(
@@ -340,11 +318,12 @@ class PgDiskANN(VectorDB):
         if filters:
             gt = filters.get("id")
             result = self.cursor.execute(
-                    self._filtered_search, (gt, q, k), prepare=True, binary=True
-                    )
+                self._filtered_search,
+                (gt, q, k),
+                prepare=True,
+                binary=True,
+            )
         else:
-            result = self.cursor.execute(
-                    self._unfiltered_search, (q, k), prepare=True, binary=True
-                    )
+            result = self.cursor.execute(self._unfiltered_search, (q, k), prepare=True, binary=True)
 
         return [int(i[0]) for i in result.fetchall()]

vectordb_bench/backend/clients/pgvecto_rs/cli.py

@@ -1,9 +1,11 @@
-from typing import Annotated, Optional, Unpack
+import os
+from typing import Annotated, Unpack
 
 import click
-import os
 from pydantic import SecretStr
 
+from vectordb_bench.backend.clients import DB
+
 from ....cli.cli import (
     CommonTypedDict,
     HNSWFlavor1,
@@ -12,12 +14,12 @@ from ....cli.cli import (
     click_parameter_decorators_from_typed_dict,
     run,
 )
-from vectordb_bench.backend.clients import DB
 
 
 class PgVectoRSTypedDict(CommonTypedDict):
     user_name: Annotated[
-        str, click.option("--user-name", type=str, help="Db username", required=True)
+        str,
+        click.option("--user-name", type=str, help="Db username", required=True),
     ]
     password: Annotated[
         str,
@@ -30,14 +32,10 @@ class PgVectoRSTypedDict(CommonTypedDict):
         ),
     ]
 
-    host: Annotated[
-        str, click.option("--host", type=str, help="Db host", required=True)
-    ]
-    db_name: Annotated[
-        str, click.option("--db-name", type=str, help="Db name", required=True)
-    ]
+    host: Annotated[str, click.option("--host", type=str, help="Db host", required=True)]
+    db_name: Annotated[str, click.option("--db-name", type=str, help="Db name", required=True)]
     max_parallel_workers: Annotated[
-        Optional[int],
+        int | None,
         click.option(
             "--max-parallel-workers",
             type=int,

vectordb_bench/backend/clients/pgvecto_rs/config.py

@@ -1,11 +1,11 @@
 from abc import abstractmethod
 from typing import TypedDict
 
+from pgvecto_rs.types import Flat, Hnsw, IndexOption, Ivf, Quantization
+from pgvecto_rs.types.index import QuantizationRatio, QuantizationType
 from pydantic import BaseModel, SecretStr
-from pgvecto_rs.types import IndexOption, Ivf, Hnsw, Flat, Quantization
-from pgvecto_rs.types.index import QuantizationType, QuantizationRatio
 
-from ..api import DBConfig, DBCaseConfig, IndexType, MetricType
+from ..api import DBCaseConfig, DBConfig, IndexType, MetricType
 
 POSTGRE_URL_PLACEHOLDER = "postgresql://%s:%s@%s/%s"
 
@@ -52,14 +52,14 @@ class PgVectoRSIndexConfig(BaseModel, DBCaseConfig):
     def parse_metric(self) -> str:
         if self.metric_type == MetricType.L2:
             return "vector_l2_ops"
-        elif self.metric_type == MetricType.IP:
+        if self.metric_type == MetricType.IP:
             return "vector_dot_ops"
         return "vector_cos_ops"
 
     def parse_metric_fun_op(self) -> str:
         if self.metric_type == MetricType.L2:
             return "<->"
-        elif self.metric_type == MetricType.IP:
+        if self.metric_type == MetricType.IP:
             return "<#>"
         return "<=>"
 
@@ -85,9 +85,7 @@ class PgVectoRSHNSWConfig(PgVectoRSIndexConfig):
         if self.quantization_type is None:
             quantization = None
         else:
-            quantization = Quantization(
-                typ=self.quantization_type, ratio=self.quantization_ratio
-            )
+            quantization = Quantization(typ=self.quantization_type, ratio=self.quantization_ratio)
 
         option = IndexOption(
             index=Hnsw(
@@ -115,9 +113,7 @@ class PgVectoRSIVFFlatConfig(PgVectoRSIndexConfig):
         if self.quantization_type is None:
             quantization = None
         else:
-            quantization = Quantization(
-                typ=self.quantization_type, ratio=self.quantization_ratio
-            )
+            quantization = Quantization(typ=self.quantization_type, ratio=self.quantization_ratio)
 
         option = IndexOption(
             index=Ivf(nlist=self.lists, quantization=quantization),
@@ -139,9 +135,7 @@ class PgVectoRSFLATConfig(PgVectoRSIndexConfig):
         if self.quantization_type is None:
             quantization = None
         else:
-            quantization = Quantization(
-                typ=self.quantization_type, ratio=self.quantization_ratio
-            )
+            quantization = Quantization(typ=self.quantization_type, ratio=self.quantization_ratio)
 
         option = IndexOption(
             index=Flat(