IVF Flat

1
cdef class Index

1
def trained(self)

1
def n_lists(self)

1
def dim(self)

1
def centers(self)

1
cdef class IndexParams

1
def __init__(self, *, n_lists=1024, metric="sqeuclidean", metric_arg=2.0, kmeans_n_iters=20, kmeans_trainset_fraction=0.5, adaptive_centers=False, add_data_on_build=True, conservative_memory_allocation=False)

1
def get_handle(self)

1
def metric(self)

1
def metric_arg(self)

1
def add_data_on_build(self)

1
def n_lists(self)

1
def kmeans_n_iters(self)

1
def kmeans_trainset_fraction(self)

1
def adaptive_centers(self)

1
def conservative_memory_allocation(self)

1
cdef class SearchParams

1
def __init__(self, *, n_probes=20)

1
def get_handle(self)

1
def n_probes(self)

1
def build(IndexParams index_params, dataset, resources=None)

1
>>> import cupy as cp
2
>>> from cuvs.neighbors import ivf_flat
3
>>> n_samples = 50000
4
>>> n_features = 50
5
>>> n_queries = 1000
6
>>> k = 10
7
>>> dataset = cp.random.random_sample((n_samples, n_features),
8
...                                   dtype=cp.float32)
9
>>> build_params = ivf_flat.IndexParams(metric="sqeuclidean")
10
>>> index = ivf_flat.build(build_params, dataset)
11
>>> distances, neighbors = ivf_flat.search(ivf_flat.SearchParams(),
12
...                                        index, dataset,
13
...                                        k)
14
>>> distances = cp.asarray(distances)
15
>>> neighbors = cp.asarray(neighbors)

1
def extend(Index index, new_vectors, new_indices, resources=None)

1
>>> import cupy as cp
2
>>> from cuvs.neighbors import ivf_flat
3
>>> n_samples = 50000
4
>>> n_features = 50
5
>>> n_queries = 1000
6
>>> dataset = cp.random.random_sample((n_samples, n_features),
7
...                                   dtype=cp.float32)
8
>>> index = ivf_flat.build(ivf_flat.IndexParams(), dataset)
9
>>> n_rows = 100
10
>>> more_data = cp.random.random_sample((n_rows, n_features),
11
...                                     dtype=cp.float32)
12
>>> indices = n_samples + cp.arange(n_rows, dtype=cp.int64)
13
>>> index = ivf_flat.extend(index, more_data, indices)
14
>>> # Search using the built index
15
>>> queries = cp.random.random_sample((n_queries, n_features),
16
...                                   dtype=cp.float32)
17
>>> distances, neighbors = ivf_flat.search(ivf_flat.SearchParams(),
18
...                                      index, queries,
19
...                                      k=10)

1
def load(filename, resources=None)

1
def save(filename, Index index, bool include_dataset=True, resources=None)

1
>>> import cupy as cp
2
>>> from cuvs.neighbors import ivf_flat
3
>>> n_samples = 50000
4
>>> n_features = 50
5
>>> dataset = cp.random.random_sample((n_samples, n_features),
6
...                                   dtype=cp.float32)
7
>>> # Build index
8
>>> index = ivf_flat.build(ivf_flat.IndexParams(), dataset)
9
>>> # Serialize and deserialize the ivf_flat index built
10
>>> ivf_flat.save("my_index.bin", index)
11
>>> index_loaded = ivf_flat.load("my_index.bin")

1
def search(SearchParams search_params, Index index, queries, k, neighbors=None, distances=None, resources=None, filter=None)

1
>>> import cupy as cp
2
>>> from cuvs.neighbors import ivf_flat
3
>>> n_samples = 50000
4
>>> n_features = 50
5
>>> n_queries = 1000
6
>>> dataset = cp.random.random_sample((n_samples, n_features),
7
...                                   dtype=cp.float32)
8
>>> # Build the index
9
>>> index = ivf_flat.build(ivf_flat.IndexParams(), dataset)
10
>>>
11
>>> # Search using the built index
12
>>> queries = cp.random.random_sample((n_queries, n_features),
13
...                                   dtype=cp.float32)
14
>>> k = 10
15
>>> search_params = ivf_flat.SearchParams(n_probes=20)
16
>>>
17
>>> distances, neighbors = ivf_flat.search(search_params, index, queries,
18
...                                     k)