Rename spfresh to hfresh

Author: rlmanrique

weaviate/collections/classes/config.py

@@ -45,7 +45,7 @@
     _VectorIndexConfigDynamicUpdate,
     _VectorIndexConfigFlatUpdate,
     _VectorIndexConfigHNSWUpdate,
-    _VectorIndexConfigSPFreshUpdate,
+    _VectorIndexConfigHFreshUpdate,
     _VectorIndexConfigUpdate,
 )
 from weaviate.collections.classes.config_vector_index import (
@@ -1888,7 +1888,7 @@ def vector_index_type() -> str:
 VectorIndexConfigHNSW = _VectorIndexConfigHNSW
 
 @dataclass
-class _VectorIndexConfigSPFresh(_VectorIndexConfig):
+class _VectorIndexConfigHFresh(_VectorIndexConfig):
     distance_metric: VectorDistances
     max_posting_size: int
     min_posting_size: int
@@ -1898,9 +1898,9 @@ class _VectorIndexConfigSPFresh(_VectorIndexConfig):
 
     @staticmethod
     def vector_index_type() -> str:
-        return VectorIndexType.SPFRESH.value
+        return VectorIndexType.HFRESH.value
 
-VectorIndexConfigSPFresh = _VectorIndexConfigSPFresh
+VectorIndexConfigHFresh = _VectorIndexConfigHFresh
 
 @dataclass
 class _VectorIndexConfigFlat(_VectorIndexConfig):
@@ -1975,7 +1975,7 @@ def to_dict(self) -> Dict[str, Any]:
 class _NamedVectorConfig(_ConfigBase):
     vectorizer: _NamedVectorizerConfig
     vector_index_config: Union[
-        VectorIndexConfigHNSW, VectorIndexConfigFlat, VectorIndexConfigDynamic, VectorIndexConfigSPFresh
+        VectorIndexConfigHNSW, VectorIndexConfigFlat, VectorIndexConfigDynamic, VectorIndexConfigHFresh
     ]
 
     def to_dict(self) -> Dict:
@@ -2000,7 +2000,7 @@ class _CollectionConfig(_ConfigBase):
     reranker_config: Optional[RerankerConfig]
     sharding_config: Optional[ShardingConfig]
     vector_index_config: Union[
-        VectorIndexConfigHNSW, VectorIndexConfigFlat, VectorIndexConfigDynamic, VectorIndexConfigSPFresh, None
+        VectorIndexConfigHNSW, VectorIndexConfigFlat, VectorIndexConfigDynamic, VectorIndexConfigHFresh, None
     ]
     vector_index_type: Optional[VectorIndexType]
     vectorizer_config: Optional[VectorizerConfig]
@@ -2641,21 +2641,21 @@ def dynamic(
         )
 
     @staticmethod
-    def spfresh(
+    def hfresh(
         max_posting_size: Optional[int] = None,
         min_posting_size: Optional[int] = None,
         rng_factor: Optional[int] = None,
         search_probe: Optional[int] = None,
         quantizer: Optional[_RQConfigUpdate] = None,
-    ) -> _VectorIndexConfigSPFreshUpdate:
-        """Create an `_VectorIndexConfigSPFreshUpdate` object to update the configuration of the SPFresh vector index.
+    ) -> _VectorIndexConfigHFreshUpdate:
+        """Create an `_VectorIndexConfigHFreshUpdate` object to update the configuration of the HFresh vector index.
         
         Use this method when defining the `vectorizer_config` argument in `collection.update()`.
         
         Args:
             See [the docs](https://weaviate.io/developers/weaviate/configuration/indexes#configure-the-inverted-index) for a more detailed view!
         """  # noqa: D417 (missing argument descriptions in the docstring)
-        return _VectorIndexConfigSPFreshUpdate(
+        return _VectorIndexConfigHFreshUpdate(
             maxPostingSize=max_posting_size,
             minPostingSize=min_posting_size,
             rngFactor=rng_factor,

weaviate/collections/classes/config_methods.py

@@ -39,7 +39,7 @@
     _VectorIndexConfigDynamic,
     _VectorIndexConfigFlat,
     _VectorIndexConfigHNSW,
-    _VectorIndexConfigSPFresh,
+    _VectorIndexConfigHFresh,
     _VectorizerConfig,
 )
 
@@ -211,9 +211,9 @@ def __get_hnsw_config(config: Dict[str, Any]) -> _VectorIndexConfigHNSW:
         multi_vector=__get_multivector(config),
     )
 
-def __get_spfresh_config(config: Dict[str, Any]) -> _VectorIndexConfigSPFresh:
+def __get_hfresh_config(config: Dict[str, Any]) -> _VectorIndexConfigHFresh:
     quantizer = __get_quantizer_config(config)
-    return _VectorIndexConfigSPFresh(
+    return _VectorIndexConfigHFresh(
         distance_metric=VectorDistances(config.get("distance")),
         max_posting_size=config["maxPostingSize"],
         min_posting_size=config["minPostingSize"],
@@ -236,7 +236,7 @@ def __get_flat_config(config: Dict[str, Any]) -> _VectorIndexConfigFlat:
 
 def __get_vector_index_config(
     schema: Dict[str, Any],
-) -> Union[_VectorIndexConfigHNSW, _VectorIndexConfigFlat, _VectorIndexConfigDynamic, _VectorIndexConfigSPFresh, None]:
+) -> Union[_VectorIndexConfigHNSW, _VectorIndexConfigFlat, _VectorIndexConfigDynamic, _VectorIndexConfigHFresh, None]:
     if "vectorIndexConfig" not in schema:
         return None
     if schema["vectorIndexType"] == "hnsw":
@@ -250,8 +250,8 @@ def __get_vector_index_config(
             hnsw=__get_hnsw_config(schema["vectorIndexConfig"]["hnsw"]),
             flat=__get_flat_config(schema["vectorIndexConfig"]["flat"]),
         )
-    elif schema["vectorIndexType"] == "spfresh":
-        return __get_spfresh_config(schema["vectorIndexConfig"])
+    elif schema["vectorIndexType"] == "hfresh":
+        return __get_hfresh_config(schema["vectorIndexConfig"])
     else:
         return None
 

weaviate/collections/classes/config_named_vectors.py

@@ -15,7 +15,7 @@
     _VectorIndexConfigDynamicUpdate,
     _VectorIndexConfigFlatUpdate,
     _VectorIndexConfigHNSWUpdate,
-    _VectorIndexConfigSPFreshUpdate,
+    _VectorIndexConfigHFreshUpdate,
     _VectorIndexConfigUpdate,
 )
 from weaviate.collections.classes.config_vectorizers import (
@@ -1339,7 +1339,7 @@ def update(
         *,
         vector_index_config: Union[
             _VectorIndexConfigHNSWUpdate,
-            _VectorIndexConfigSPFreshUpdate,
+            _VectorIndexConfigHFreshUpdate,
             _VectorIndexConfigFlatUpdate,
             _VectorIndexConfigDynamicUpdate,
         ],

weaviate/collections/classes/config_vector_index.py

@@ -35,13 +35,13 @@ class VectorIndexType(str, Enum):
         HNSW: Hierarchical Navigable Small World (HNSW) index.
         FLAT: Flat index.
         DYNAMIC: Dynamic index.
-        SPFRESH: SPFRESH index.
+        HFRESH: HFRESH index.
     """
 
     HNSW = "hnsw"
     FLAT = "flat"
     DYNAMIC = "dynamic"
-    SPFRESH = "spfresh"
+    HFRESH = "hfresh"
 
 
 class _MultiVectorConfigCreateBase(_ConfigCreateModel):
@@ -130,7 +130,7 @@ def vector_index_type() -> VectorIndexType:
         return VectorIndexType.HNSW
 
 
-class _VectorIndexConfigSPFreshCreate(_VectorIndexConfigCreate):
+class _VectorIndexConfigHFreshCreate(_VectorIndexConfigCreate):
     maxPostingSize: Optional[int]
     minPostingSize: Optional[int]
     replicas: Optional[int]
@@ -139,7 +139,7 @@ class _VectorIndexConfigSPFreshCreate(_VectorIndexConfigCreate):
 
     @staticmethod
     def vector_index_type() -> VectorIndexType:
-        return VectorIndexType.SPFRESH
+        return VectorIndexType.HFRESH
 
 
 class _VectorIndexConfigFlatCreate(_VectorIndexConfigCreate):
@@ -164,15 +164,15 @@ def vector_index_type() -> VectorIndexType:
         return VectorIndexType.HNSW
 
 
-class _VectorIndexConfigSPFreshUpdate(_VectorIndexConfigUpdate):
+class _VectorIndexConfigHFreshUpdate(_VectorIndexConfigUpdate):
     maxPostingSize: Optional[int]
     minPostingSize: Optional[int]
     rngFactor: Optional[int]
     searchProbe: Optional[int]
 
     @staticmethod
     def vector_index_type() -> VectorIndexType:
-        return VectorIndexType.SPFRESH
+        return VectorIndexType.HFRESH
 
 
 class _VectorIndexConfigFlatUpdate(_VectorIndexConfigUpdate):
@@ -591,7 +591,7 @@ def hnsw(
         )
 
     @staticmethod
-    def spfresh(
+    def hfresh(
         distance_metric: Optional[VectorDistances] = None,
         max_posting_size: Optional[int] = None,
         min_posting_size: Optional[int] = None,
@@ -601,15 +601,15 @@ def spfresh(
         quantizer: Optional[_QuantizerConfigCreate] = None,
         multi_vector: Optional[_MultiVectorConfigCreate] = None,
 
-    ) -> _VectorIndexConfigSPFreshCreate:
-        """Create a `_VectorIndexConfigSPFreshCreate` object to be used when defining the SPFresh vector index configuration of Weaviate.
+    ) -> _VectorIndexConfigHFreshCreate:
+        """Create a `_VectorIndexConfigHFreshCreate` object to be used when defining the HFresh vector index configuration of Weaviate.
 
         Use this method when defining the `vector_index_config` argument in `collections.create()`.
 
         Args:
-            See [the docs](https://weaviate.io/developers/weaviate/configuration/indexes#how-to-configure-spfresh) for a more detailed view!
+            See [the docs](https://weaviate.io/developers/weaviate/configuration/indexes#how-to-configure-hfresh) for a more detailed view!
         """
-        return _VectorIndexConfigSPFreshCreate(
+        return _VectorIndexConfigHFreshCreate(
             distance=distance_metric,
             maxPostingSize=max_posting_size,
             minPostingSize=min_posting_size,

weaviate/collections/classes/config_vectors.py

@@ -20,8 +20,8 @@
     _VectorIndexConfigFlatUpdate,
     _VectorIndexConfigHNSWCreate,
     _VectorIndexConfigHNSWUpdate,
-    _VectorIndexConfigSPFreshCreate,
-    _VectorIndexConfigSPFreshUpdate,
+    _VectorIndexConfigHFreshCreate,
+    _VectorIndexConfigHFreshUpdate,
     _VectorIndexConfigUpdate,
 )
 from weaviate.collections.classes.config_vectorizers import (
@@ -129,8 +129,8 @@ def __hnsw(
         )
 
     @staticmethod
-    def __spfresh(*, quantizer: Optional[_QuantizerConfigCreate]) -> _VectorIndexConfigSPFreshCreate:
-        return _VectorIndexConfigSPFreshCreate(
+    def __hfresh(*, quantizer: Optional[_QuantizerConfigCreate]) -> _VectorIndexConfigHFreshCreate:
+        return _VectorIndexConfigHFreshCreate(
             distance_metric=None,
             maxPostingSize=None,
             minPostingSize=None,
@@ -1776,7 +1776,7 @@ def update(
         name: Optional[str] = None,
         vector_index_config: Union[
             _VectorIndexConfigHNSWUpdate,
-            _VectorIndexConfigSPFreshUpdate,
+            _VectorIndexConfigHFreshUpdate,
             _VectorIndexConfigFlatUpdate,
             _VectorIndexConfigDynamicUpdate,
         ],

weaviate/collections/config/async_.pyi

@@ -21,7 +21,7 @@ from weaviate.collections.classes.config import (
     _VectorConfigUpdate,
     _VectorIndexConfigFlatUpdate,
     _VectorIndexConfigHNSWUpdate,
-    _VectorIndexConfigSPFreshUpdate,
+    _VectorIndexConfigHFreshUpdate,
 )
 from weaviate.collections.classes.config_vector_index import _VectorIndexConfigDynamicUpdate
 from weaviate.connect.v4 import ConnectionAsync
@@ -46,14 +46,14 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
         multi_tenancy_config: Optional[_MultiTenancyConfigUpdate] = None,
         replication_config: Optional[_ReplicationConfigUpdate] = None,
         vector_index_config: Optional[
-            Union[_VectorIndexConfigHNSWUpdate, _VectorIndexConfigFlatUpdate, _VectorIndexConfigSPFreshUpdate]
+            Union[_VectorIndexConfigHNSWUpdate, _VectorIndexConfigFlatUpdate, _VectorIndexConfigHFreshUpdate]
         ] = None,
         vectorizer_config: Optional[
             Union[
                 _VectorIndexConfigHNSWUpdate,
                 _VectorIndexConfigFlatUpdate,
                 _VectorIndexConfigDynamicUpdate,
-                _VectorIndexConfigSPFreshUpdate,
+                _VectorIndexConfigHFreshUpdate,
                 List[_NamedVectorConfigUpdate],
             ]
         ] = None,

weaviate/collections/config/executor.py

@@ -38,7 +38,7 @@
     _VectorConfigUpdate,
     _VectorIndexConfigFlatUpdate,
     _VectorIndexConfigHNSWUpdate,
-    _VectorIndexConfigSPFreshUpdate,
+    _VectorIndexConfigHFreshUpdate,
 )
 from weaviate.collections.classes.config_methods import (
     _collection_config_from_json,
@@ -135,15 +135,15 @@ def update(
             Union[
                 _VectorIndexConfigHNSWUpdate,
                 _VectorIndexConfigFlatUpdate,
-                _VectorIndexConfigSPFreshUpdate,
+                _VectorIndexConfigHFreshUpdate,
             ]
         ] = None,
         vectorizer_config: Optional[
             Union[
                 _VectorIndexConfigHNSWUpdate,
                 _VectorIndexConfigFlatUpdate,
                 _VectorIndexConfigDynamicUpdate,
-                _VectorIndexConfigSPFreshUpdate,
+                _VectorIndexConfigHFreshUpdate,
                 List[_NamedVectorConfigUpdate],
             ]
         ] = None,
@@ -187,7 +187,7 @@ def update(
                 _VectorIndexConfigHNSWUpdate,
                 _VectorIndexConfigFlatUpdate,
                 _VectorIndexConfigDynamicUpdate,
-                _VectorIndexConfigSPFreshUpdate,
+                _VectorIndexConfigHFreshUpdate,
             ),
         ):
             _Warnings.vectorizer_config_in_config_update()

weaviate/collections/config/sync.pyi

@@ -21,7 +21,7 @@ from weaviate.collections.classes.config import (
     _VectorConfigUpdate,
     _VectorIndexConfigFlatUpdate,
     _VectorIndexConfigHNSWUpdate,
-    _VectorIndexConfigSPFreshUpdate,
+    _VectorIndexConfigHFreshUpdate,
 )
 from weaviate.collections.classes.config_vector_index import _VectorIndexConfigDynamicUpdate
 from weaviate.connect.v4 import ConnectionSync
@@ -44,14 +44,14 @@ class _ConfigCollection(_ConfigCollectionExecutor[ConnectionSync]):
         multi_tenancy_config: Optional[_MultiTenancyConfigUpdate] = None,
         replication_config: Optional[_ReplicationConfigUpdate] = None,
         vector_index_config: Optional[
-            Union[_VectorIndexConfigHNSWUpdate, _VectorIndexConfigFlatUpdate, _VectorIndexConfigSPFreshUpdate]
+            Union[_VectorIndexConfigHNSWUpdate, _VectorIndexConfigFlatUpdate, _VectorIndexConfigHFreshUpdate]
         ] = None,
         vectorizer_config: Optional[
             Union[
                 _VectorIndexConfigHNSWUpdate,
                 _VectorIndexConfigFlatUpdate,
                 _VectorIndexConfigDynamicUpdate,
-                _VectorIndexConfigSPFreshUpdate,
+                _VectorIndexConfigHFreshUpdate,
                 List[_NamedVectorConfigUpdate],
             ]
         ] = None,

weaviate/outputs/config.py

@@ -23,7 +23,7 @@
     VectorDistances,
     VectorIndexConfigFlat,
     VectorIndexConfigHNSW,
-    VectorIndexConfigSPFresh,
+    VectorIndexConfigHFresh,
     VectorIndexType,
     VectorizerConfig,
     Vectorizers,
@@ -53,7 +53,7 @@
     "ShardTypes",
     "VectorDistances",
     "VectorIndexConfigHNSW",
-    "VectorIndexConfigSPFresh",
+    "VectorIndexConfigHFresh",
     "VectorIndexConfigFlat",
     "VectorIndexType",
     "Vectorizers",