needlestack.collections package¶

Submodules¶

needlestack.collections.collection module¶

class needlestack.collections.collection.Collection[source]¶

Bases: object

A logical collection made of shards where kNN queries can be performed.

name¶: Name of collection

shards¶: Dictionary of shard names to shards

replication_factor¶: Number of replicas per shard in the cluster

enable_id_to_vector¶: Enable retrieving vector from id

dimension¶: Dimensionality of the vectors

add_shard(shard)[source]¶

drop_shard(name)[source]¶

classmethod from_proto(proto)[source]¶

Return type: Collection

load()[source]¶

merge_proto(proto)[source]¶

populate_from_proto(proto)[source]¶

query(X, k, shard_names)[source]¶

Return type: Iterable[SearchResultItem]

retrieve(id, shard_names)[source]¶

Return type: Optional[RetrievalResultItem]

update_available()[source]¶

Return type: bool

validate()[source]¶

needlestack.collections.shard module¶

class needlestack.collections.shard.Shard[source]¶

Bases: object

A logical shard containing a index to perform kNN search.

name¶: Name of shard

weight¶: Weight of shard

index¶: BaseIndex for kNN queries

enable_id_to_vector¶: Enable retrieving vector from id

add_vectors(X, metadatas)[source]¶

enable_id_to_vector = False

classmethod from_proto(proto)[source]¶

Return type: Shard

load()[source]¶

populate_from_proto(proto)[source]¶

query(X, k)[source]¶

Return type: List[SearchResultItem]

retrieve(id)[source]¶

Return type: RetrievalResultItem

set_vectors(X, metadatas)[source]¶

update_available()[source]¶

Return type: bool

Module contents¶