IVF Flat

Source header: cuvs/neighbors/ivf_flat.hpp

IVF-Flat index search parameters

neighbors::ivf_flat::search_params

IVF-Flat index search parameters

1
struct search_params : cuvs::neighbors::search_params { ... };

Fields

neighbors::ivf_flat::list_spec::make_list_extents

Determine the extents of an array enough to hold a given amount of data.

1
constexpr auto make_list_extents(SizeT n_rows) const -> list_extents;

Parameters

Returns

list_extents

IVF-Flat index

neighbors::ivf_flat::index

IVF-flat index.

1
template <typename T, typename IdxT>
2
struct index : cuvs::neighbors::index { ... };

neighbors::ivf_flat::index::index

Construct an empty index.

1
index(raft::resources const& res);

Constructs an empty index. This index will either need to be trained with build or loaded from a saved copy with deserialize

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::index::index

Construct an empty index. It needs to be trained and then populated.

1
index(raft::resources const& res, const index_params& params, uint32_t dim);

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::index::index

Construct an empty index. It needs to be trained and then populated.

1
index(raft::resources const& res,
2
cuvs::distance::DistanceType metric,
3
uint32_t n_lists,
4
bool adaptive_centers,
5
bool conservative_memory_allocation,
6
uint32_t dim);

Parameters

Returns

void

neighbors::ivf_flat::index::veclen

Vectorized load/store size in elements, determines the size of interleaved data chunks.

1
uint32_t veclen() const noexcept;

Returns

uint32_t

neighbors::ivf_flat::index::metric

Distance metric used for clustering.

1
cuvs::distance::DistanceType metric() const noexcept;

Returns

cuvs::distance::DistanceType

neighbors::ivf_flat::index::adaptive_centers

Whether centers() change upon extending the index (ivf_flat::extend).

1
bool adaptive_centers() const noexcept;

Returns

bool

neighbors::ivf_flat::index::list_sizes

Sizes of the lists (clusters) [n_lists]

1
raft::device_vector_view<uint32_t, uint32_t> list_sizes() noexcept;

NB: This may differ from the actual list size if the shared lists have been extended by another index

Returns

raft::device_vector_view<uint32_t, uint32_t>

neighbors::ivf_flat::index::centers

k-means cluster centers corresponding to the lists [n_lists, dim]

1
raft::device_matrix_view<float, uint32_t, raft::row_major> centers() noexcept;

Returns

raft::device_matrix_view<float, uint32_t, raft::row_major>

neighbors::ivf_flat::index::center_norms

(Optional) Precomputed norms of the centers w.r.t. the chosen distance metric [n_lists].

1
std::optional<raft::device_vector_view<float, uint32_t>> center_norms() noexcept;

NB: this may be empty if the index is empty or if the metric does not require the center norms calculation.

Returns

std::optional<raft::device_vector_view<float, uint32_t>>

neighbors::ivf_flat::index::accum_sorted_sizes

Accumulated list sizes, sorted in descending order [n_lists + 1].

1
auto accum_sorted_sizes() noexcept -> raft::host_vector_view<IdxT, uint32_t>;

The last value contains the total length of the index. The value at index zero is always zero.

That is, the content of this span is as if the list_sizes was sorted and then accumulated.

This span is used during search to estimate the maximum size of the workspace.

Returns

raft::host_vector_view<IdxT, uint32_t>

neighbors::ivf_flat::index::size

Total length of the index.

1
IdxT size() const noexcept;

Returns

IdxT

neighbors::ivf_flat::index::dim

Dimensionality of the data.

1
uint32_t dim() const noexcept;

Returns

uint32_t

neighbors::ivf_flat::index::n_lists

Number of clusters/inverted lists.

1
uint32_t n_lists() const noexcept;

Returns

uint32_t

neighbors::ivf_flat::index::inds_ptrs

Pointers to the inverted lists (clusters) indices [n_lists].

1
raft::device_vector_view<IdxT*, uint32_t> inds_ptrs() noexcept;

Returns

raft::device_vector_view<IdxT*, uint32_t>

neighbors::ivf_flat::index::conservative_memory_allocation

Whether to use conservative memory allocation when extending the list (cluster) data

1
bool conservative_memory_allocation() const noexcept;

(see index_params.conservative_memory_allocation).

Returns

bool

neighbors::ivf_flat::index::lists

Lists’ data and indices.

1
std::vector<std::shared_ptr<list_data<T, IdxT>>>& lists() noexcept;

Returns

std::vector<std::shared_ptr<list_data<T, IdxT>>>&

IVF-Flat index build

neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const float, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<float, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<float, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const float, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<float, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const half, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<half, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<half, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const half, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<half, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const int8_t, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<int8_t, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<int8_t, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const int8_t, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<int8_t, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const uint8_t, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::device_matrix_view<const uint8_t, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const float, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<float, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<float, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const float, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<float, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const half, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<half, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<half, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const half, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<half, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const int8_t, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<int8_t, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<int8_t, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const int8_t, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<int8_t, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>;

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>

Additional overload: neighbors::ivf_flat::build

Build the index from the dataset for efficient search.

1
void build(raft::resources const& handle,
2
const cuvs::neighbors::ivf_flat::index_params& index_params,
3
raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> dataset,
4
cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>& idx);

NB: Currently, the following distance metrics are supported:

• L2Expanded
• L2Unexpanded
• InnerProduct
• CosineExpanded

Note, if index_params.add_data_on_build is set to true, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

IVF-Flat index extend

neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::device_matrix_view<const float, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<float, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<float, int64_t>;

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<float, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::device_matrix_view<const float, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<float, int64_t>* idx);

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::device_matrix_view<const half, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<half, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<half, int64_t>;

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<half, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::device_matrix_view<const half, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<half, int64_t>* idx);

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::device_matrix_view<const int8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<int8_t, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<int8_t, int64_t>;

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<int8_t, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::device_matrix_view<const int8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<int8_t, int64_t>* idx);

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::device_matrix_view<const uint8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>;

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::device_matrix_view<const uint8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::device_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>* idx);

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::host_matrix_view<const float, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<float, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<float, int64_t>;

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<float, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::host_matrix_view<const float, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<float, int64_t>* idx);

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::host_matrix_view<const half, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<half, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<half, int64_t>;

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<half, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::host_matrix_view<const half, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<half, int64_t>* idx);

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::host_matrix_view<const int8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<int8_t, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<int8_t, int64_t>;

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<int8_t, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::host_matrix_view<const int8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<int8_t, int64_t>* idx);

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::extend

Build a new index containing the data of the original plus new extra vectors.

1
auto extend(raft::resources const& handle,
2
raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
const cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>& idx)
5
-> cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>;

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Implementation note: The new data is clustered according to existing kmeans clusters, then the cluster centers are adjusted to match the newly labeled data.

Usage example:

Parameters

Returns

cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>

Additional overload: neighbors::ivf_flat::extend

Extend the index in-place with the new data.

1
void extend(raft::resources const& handle,
2
raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> new_vectors,
3
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices,
4
cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>* idx);

Note, the user can set a stream pool in the input raft::resource with at least one stream to enable kernel and copy overlapping.

Usage example:

Parameters

Returns

void

IVF-Flat index serialize

neighbors::ivf_flat::serialize

Save the index to file.

1
void serialize(raft::resources const& handle,
2
const std::string& filename,
3
const cuvs::neighbors::ivf_flat::index<float, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

neighbors::ivf_flat::deserialize

Load index from file.

1
void deserialize(raft::resources const& handle,
2
const std::string& filename,
3
cuvs::neighbors::ivf_flat::index<float, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Write the index to an output stream

1
void serialize(raft::resources const& handle,
2
std::ostream& os,
3
const cuvs::neighbors::ivf_flat::index<float, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from input stream

1
void deserialize(raft::resources const& handle,
2
std::istream& is,
3
cuvs::neighbors::ivf_flat::index<float, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Save the index to file.

1
void serialize(raft::resources const& handle,
2
const std::string& filename,
3
const cuvs::neighbors::ivf_flat::index<half, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from file.

1
void deserialize(raft::resources const& handle,
2
const std::string& filename,
3
cuvs::neighbors::ivf_flat::index<half, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Write the index to an output stream

1
void serialize(raft::resources const& handle,
2
std::ostream& os,
3
const cuvs::neighbors::ivf_flat::index<half, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from input stream

1
void deserialize(raft::resources const& handle,
2
std::istream& is,
3
cuvs::neighbors::ivf_flat::index<half, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Save the index to file.

1
void serialize(raft::resources const& handle,
2
const std::string& filename,
3
const cuvs::neighbors::ivf_flat::index<int8_t, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from file.

1
void deserialize(raft::resources const& handle,
2
const std::string& filename,
3
cuvs::neighbors::ivf_flat::index<int8_t, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Write the index to an output stream

1
void serialize(raft::resources const& handle,
2
std::ostream& os,
3
const cuvs::neighbors::ivf_flat::index<int8_t, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from input stream

1
void deserialize(raft::resources const& handle,
2
std::istream& is,
3
cuvs::neighbors::ivf_flat::index<int8_t, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Save the index to file.

1
void serialize(raft::resources const& handle,
2
const std::string& filename,
3
const cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from file.

1
void deserialize(raft::resources const& handle,
2
const std::string& filename,
3
cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::serialize

Write the index to an output stream

1
void serialize(raft::resources const& handle,
2
std::ostream& os,
3
const cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>& index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::deserialize

Load index from input stream

1
void deserialize(raft::resources const& handle,
2
std::istream& is,
3
cuvs::neighbors::ivf_flat::index<uint8_t, int64_t>* index);

Experimental, both the API and the serialization format are subject to change.

Parameters

Returns

void

Helper functions for IVF Flat

neighbors::ivf_flat::helpers::codepacker::pack

Write flat codes into an existing list by the given offset.

1
void pack(raft::resources const& res,
2
raft::device_matrix_view<const float, uint32_t, raft::row_major> codes,
3
uint32_t veclen,
4
uint32_t offset,
5
raft::device_mdspan<float,
6
typename list_spec<uint32_t, float, int64_t>::list_extents,
7
raft::row_major> list_data);

NB: no memory allocation happens here; the list must fit the data (offset + n_vec).

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::pack

Write flat codes into an existing list by the given offset.

1
void pack(raft::resources const& res,
2
raft::device_matrix_view<const half, uint32_t, raft::row_major> codes,
3
uint32_t veclen,
4
uint32_t offset,
5
raft::device_mdspan<half,
6
typename list_spec<uint32_t, half, int64_t>::list_extents,
7
raft::row_major> list_data);

NB: no memory allocation happens here; the list must fit the data (offset + n_vec).

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::pack

Write flat codes into an existing list by the given offset.

1
void pack(raft::resources const& res,
2
raft::device_matrix_view<const int8_t, uint32_t, raft::row_major> codes,
3
uint32_t veclen,
4
uint32_t offset,
5
raft::device_mdspan<int8_t,
6
typename list_spec<uint32_t, int8_t, int64_t>::list_extents,
7
raft::row_major> list_data);

NB: no memory allocation happens here; the list must fit the data (offset + n_vec).

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::pack

Write flat codes into an existing list by the given offset.

1
void pack(raft::resources const& res,
2
raft::device_matrix_view<const uint8_t, uint32_t, raft::row_major> codes,
3
uint32_t veclen,
4
uint32_t offset,
5
raft::device_mdspan<uint8_t,
6
typename list_spec<uint32_t, uint8_t, int64_t>::list_extents,
7
raft::row_major> list_data);

NB: no memory allocation happens here; the list must fit the data (offset + n_vec).

Usage example:

Parameters

Returns

void

neighbors::ivf_flat::helpers::codepacker::unpack

Unpack n_take consecutive records of a single list (cluster) in the compressed index

1
void unpack(raft::resources const& res,
2
raft::device_mdspan<const float,
3
typename list_spec<uint32_t, float, int64_t>::list_extents,
4
raft::row_major> list_data,
5
uint32_t veclen,
6
uint32_t offset,
7
raft::device_matrix_view<float, uint32_t, raft::row_major> codes);

starting at given offset.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::unpack

Unpack n_take consecutive records of a single list (cluster) in the compressed index

1
void unpack(raft::resources const& res,
2
raft::device_mdspan<const half,
3
typename list_spec<uint32_t, half, int64_t>::list_extents,
4
raft::row_major> list_data,
5
uint32_t veclen,
6
uint32_t offset,
7
raft::device_matrix_view<half, uint32_t, raft::row_major> codes);

starting at given offset.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::unpack

Unpack n_take consecutive records of a single list (cluster) in the compressed index

1
void unpack(raft::resources const& res,
2
raft::device_mdspan<const int8_t,
3
typename list_spec<uint32_t, int8_t, int64_t>::list_extents,
4
raft::row_major> list_data,
5
uint32_t veclen,
6
uint32_t offset,
7
raft::device_matrix_view<int8_t, uint32_t, raft::row_major> codes);

starting at given offset.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::unpack

Unpack n_take consecutive records of a single list (cluster) in the compressed index

1
void unpack(raft::resources const& res,
2
raft::device_mdspan<const uint8_t,
3
typename list_spec<uint32_t, uint8_t, int64_t>::list_extents,
4
raft::row_major> list_data,
5
uint32_t veclen,
6
uint32_t offset,
7
raft::device_matrix_view<uint8_t, uint32_t, raft::row_major> codes);

starting at given offset.

Usage example:

Parameters

Returns

void

neighbors::ivf_flat::helpers::codepacker::pack_1

Write one flat code into a block by the given offset. The offset indicates the id of the record

1
void pack_1(const float* flat_code, float* block, uint32_t dim, uint32_t veclen, uint32_t offset);

in the list. This function interleaves the code and is intended to later copy the interleaved codes over to the IVF list on device. NB: no memory allocation happens here; the block must fit the record (offset + 1).

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::pack_1

Write one flat code into a block by the given offset. The offset indicates the id of the record

1
void pack_1(const half* flat_code, half* block, uint32_t dim, uint32_t veclen, uint32_t offset);

in the list. This function interleaves the code and is intended to later copy the interleaved codes over to the IVF list on device. NB: no memory allocation happens here; the block must fit the record (offset + 1).

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::pack_1

Write one flat code into a block by the given offset. The offset indicates the id of the record

1
void pack_1(const int8_t* flat_code, int8_t* block, uint32_t dim, uint32_t veclen, uint32_t offset);

in the list. This function interleaves the code and is intended to later copy the interleaved codes over to the IVF list on device. NB: no memory allocation happens here; the block must fit the record (offset + 1).

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::pack_1

Write one flat code into a block by the given offset. The offset indicates the id of the record

1
void pack_1(
2
const uint8_t* flat_code, uint8_t* block, uint32_t dim, uint32_t veclen, uint32_t offset);

in the list. This function interleaves the code and is intended to later copy the interleaved codes over to the IVF list on device. NB: no memory allocation happens here; the block must fit the record (offset + 1).

Parameters

Returns

void

neighbors::ivf_flat::helpers::codepacker::unpack_1

Unpack 1 record of a single list (cluster) in the index to fetch the flat code. The offset

1
void unpack_1(const float* block, float* flat_code, uint32_t dim, uint32_t veclen, uint32_t offset);

indicates the id of the record. This function fetches one flat code from an interleaved code.

interleaved format.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::unpack_1

Unpack 1 record of a single list (cluster) in the index to fetch the flat code. The offset

1
void unpack_1(const half* block, half* flat_code, uint32_t dim, uint32_t veclen, uint32_t offset);

indicates the id of the record. This function fetches one flat code from an interleaved code.

interleaved format.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::unpack_1

Unpack 1 record of a single list (cluster) in the index to fetch the flat code. The offset

1
void unpack_1(
2
const int8_t* block, int8_t* flat_code, uint32_t dim, uint32_t veclen, uint32_t offset);

indicates the id of the record. This function fetches one flat code from an interleaved code.

interleaved format.

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::codepacker::unpack_1

Unpack 1 record of a single list (cluster) in the index to fetch the flat code. The offset

1
void unpack_1(
2
const uint8_t* block, uint8_t* flat_code, uint32_t dim, uint32_t veclen, uint32_t offset);

indicates the id of the record. This function fetches one flat code from an interleaved code.

interleaved format.

Parameters

Returns

void

neighbors::ivf_flat::helpers::reset_index

Public helper API to reset the data and indices ptrs, and the list sizes. Useful for

1
void reset_index(const raft::resources& res, index<float, int64_t>* index);

externally modifying the index without going through the build stage. The data and indices of the IVF lists will be lost.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::reset_index

Public helper API to reset the data and indices ptrs, and the list sizes. Useful for

1
void reset_index(const raft::resources& res, index<half, int64_t>* index);

externally modifying the index without going through the build stage. The data and indices of the IVF lists will be lost.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::reset_index

Public helper API to reset the data and indices ptrs, and the list sizes. Useful for

1
void reset_index(const raft::resources& res, index<int8_t, int64_t>* index);

externally modifying the index without going through the build stage. The data and indices of the IVF lists will be lost.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::reset_index

Public helper API to reset the data and indices ptrs, and the list sizes. Useful for

1
void reset_index(const raft::resources& res, index<uint8_t, int64_t>* index);

externally modifying the index without going through the build stage. The data and indices of the IVF lists will be lost.

Usage example:

Parameters

Returns

void

neighbors::ivf_flat::helpers::recompute_internal_state

Helper exposing the re-computation of list sizes and related arrays if IVF lists have been

1
void recompute_internal_state(const raft::resources& res, index<float, int64_t>* index);

modified externally.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::recompute_internal_state

Helper exposing the re-computation of list sizes and related arrays if IVF lists have been

1
void recompute_internal_state(const raft::resources& res, index<half, int64_t>* index);

modified externally.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::recompute_internal_state

Helper exposing the re-computation of list sizes and related arrays if IVF lists have been

1
void recompute_internal_state(const raft::resources& res, index<int8_t, int64_t>* index);

modified externally.

Usage example:

Parameters

Returns

void

Additional overload: neighbors::ivf_flat::helpers::recompute_internal_state

Helper exposing the re-computation of list sizes and related arrays if IVF lists have been

1
void recompute_internal_state(const raft::resources& res, index<uint8_t, int64_t>* index);

modified externally.

Usage example:

Parameters

Returns

void

Types

neighbors::ivf_flat::experimental::udf::point

Wrapper for vector elements that provides both packed and unpacked access.

For float: trivial wrapper around scalar values For int8/uint8 with Veclen > 1: wraps packed bytes in a 32-bit word

1
template <typename T, typename AccT, int Veclen>
2
struct point { ... };

Fields

neighbors::ivf_flat::experimental::udf::metric_interface

Base interface for custom distance metrics.

1
template <typename T, typename AccT, int Veclen = 1>
2
struct metric_interface { ... };