Scann
Source header: cuvs/neighbors/scann.hpp
ScaNN index build parameters
neighbors::experimental::scann::index_params
ANN parameters used by ScaNN to build index
Fields
ScaNN index type
neighbors::experimental::scann::index
ScaNN index.
The index stores the dataset and the ScaNN graph in device memory.
neighbors::experimental::scann::index::metric
Distance metric used for clustering.
Returns
neighbors::experimental::scann::index::size
Total length of the index (number of vectors).
Returns
IdxT
neighbors::experimental::scann::index::dim
Dimensionality of the data.
Returns
uint32_t
neighbors::experimental::scann::index::centers
The leaf node centers
Returns
raft::device_matrix_view<float, IdxT>
Additional overload: neighbors::experimental::scann::index::centers
The const leaf node centers
Returns
raft::device_matrix_view<const float, IdxT>
neighbors::experimental::scann::index::labels
The assignment of dataset vectors to the nearest leaf center
Returns
raft::device_vector_view<uint32_t, IdxT>
Additional overload: neighbors::experimental::scann::index::labels
the const assignment of dataset vectors to the nearest leaf center
Returns
raft::device_vector_view<const uint32_t, IdxT>
neighbors::experimental::scann::index::soar_labels
Spilled assignment of dataset vectors to nearest leaf center by
minimizing SOAR loss
Returns
raft::device_vector_view<uint32_t, IdxT>
Additional overload: neighbors::experimental::scann::index::soar_labels
const spilled assignment of dataset vectors to nearest leaf center by
minimizing SOAR loss
Returns
raft::device_vector_view<const uint32_t, IdxT>
neighbors::experimental::scann::index::coarse_centers
coarse kmeans centers for two-level trees
Returns
raft::device_matrix_view<float, IdxT>
Additional overload: neighbors::experimental::scann::index::coarse_centers
const coarse kmeans centers for two-level trees
Returns
raft::device_matrix_view<const float, IdxT>
neighbors::experimental::scann::index::coarse_labels
assignment of leaf centers to coarse centers in two-level tree
Returns
raft::device_vector_view<uint32_t, IdxT>
Additional overload: neighbors::experimental::scann::index::coarse_labels
const assignment of leaf centers to coarse centers in two-level tree
Returns
raft::device_vector_view<const uint32_t, IdxT>
neighbors::experimental::scann::index::coarse_soar_labels
spilled assignment of leaf centers to coarse centers by minimizing
SOAR loss in two-level tree
Returns
raft::device_vector_view<uint32_t, IdxT>
Additional overload: neighbors::experimental::scann::index::coarse_soar_labels
const spilled assighment of leaf centers to coarse centers by minimizing
SOAR loss in two-level tree
Returns
raft::device_vector_view<const uint32_t, IdxT>
neighbors::experimental::scann::index::n_rows
number of rows in dataset
Returns
uint32_t
neighbors::experimental::scann::index::n_leaves
number of leaf nodes in kmeans tree
Returns
uint32_t
neighbors::experimental::scann::index::pq_dim
dimension of pq subspaces
Returns
uint32_t
neighbors::experimental::scann::index::pq_codebook
const codebook for pq quanization
Returns
raft::device_matrix_view<const float, uint32_t, raft::row_major>
Additional overload: neighbors::experimental::scann::index::pq_codebook
codebook for pq quantization
Returns
raft::device_matrix_view<float, uint32_t, raft::row_major>
neighbors::experimental::scann::index::quantized_residuals
const pq quantized residuals of dataset vectors
Returns
raft::host_matrix_view<const uint8_t, IdxT, raft::row_major>
Additional overload: neighbors::experimental::scann::index::quantized_residuals
pq quanntized residuals of dataset vectors
Returns
raft::host_matrix_view<uint8_t, IdxT, raft::row_major>
neighbors::experimental::scann::index::quantized_soar_residuals
pq quantized residuals of dataset vectors using SOAR assignment
Returns
raft::host_matrix_view<const uint8_t, IdxT, raft::row_major>
Additional overload: neighbors::experimental::scann::index::quantized_soar_residuals
const pq quantized residuals of dataset vectors using SOAR assignment
Returns
raft::host_matrix_view<uint8_t, IdxT, raft::row_major>
neighbors::experimental::scann::index::bf16_dataset
bf16 quantized dataset
Returns
raft::host_matrix_view<int16_t, IdxT, raft::row_major>
Additional overload: neighbors::experimental::scann::index::bf16_dataset
const bf16 quantized dataset
Returns
raft::host_matrix_view<const int16_t, IdxT, raft::row_major>
ScaNN index build functions
neighbors::experimental::scann::build
Build the index from the dataset for efficient search.
Parameters
Returns
cuvs::neighbors::experimental::scann::index<float, int64_t>
neighbors::experimental::scann::serialize
Save the index to files in a directory
This serializes the index into a list of files for integration into OSS ScaNN for use with search
NOTE: the implementation of ScaNN index build is EXPERIMENTAL and currently not subject to comprehensive, automated testing. Accuracy and performance are not guaranteed, and could diverge without warning.
Parameters
Returns
void
ScaNN serialize functions
Additional overload: neighbors::experimental::scann::serialize
Save the index to files in a directory
This serializes the index into a list of files for integration into OSS ScaNN for use with search
NOTE: the implementation of ScaNN index build is EXPERIMENTAL and currently not subject to comprehensive, automated testing. Accuracy and performance are not guaranteed, and could diverge without warning.
Parameters
Returns
void