Neighbors Multi GPU IVF PQ

Source header: cuvs/neighbors/mg_ivf_pq.h

Multi-GPU IVF-PQ index build parameters

cuvsMultiGpuIvfPqIndexParams

Multi-GPU parameters to build IVF-PQ Index

This structure extends the base IVF-PQ index parameters with multi-GPU specific settings.

1 struct cuvsMultiGpuIvfPqIndexParams { ... };

Fields

Name	Type	Description
`base_params`	`cuvsIvfPqIndexParams_t`	Base IVF-PQ index parameters
`mode`	`cuvsMultiGpuDistributionMode`	Distribution mode for multi-GPU setup

cuvsMultiGpuIvfPqIndexParamsCreate

Allocate Multi-GPU IVF-PQ Index params, and populate with default values

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqIndexParamsCreate(cuvsMultiGpuIvfPqIndexParams_t* index_params);

Parameters

Name	Direction	Type	Description
`index_params`	in	`cuvsMultiGpuIvfPqIndexParams_t*`	cuvsMultiGpuIvfPqIndexParams_t to allocate

Returns

CUVS_EXPORT cuvsError_t

cuvsMultiGpuIvfPqIndexParamsDestroy

De-allocate Multi-GPU IVF-PQ Index params

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqIndexParamsDestroy(cuvsMultiGpuIvfPqIndexParams_t index_params);

Parameters

Name	Direction	Type	Description
`index_params`	in	`cuvsMultiGpuIvfPqIndexParams_t`

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index search parameters

cuvsMultiGpuIvfPqSearchParams

Multi-GPU parameters to search IVF-PQ index

This structure extends the base IVF-PQ search parameters with multi-GPU specific settings.

1 struct cuvsMultiGpuIvfPqSearchParams { ... };

Fields

Name	Type	Description
`base_params`	`cuvsIvfPqSearchParams_t`	Base IVF-PQ search parameters
`search_mode`	`cuvsMultiGpuReplicatedSearchMode`	Replicated search mode
`merge_mode`	`cuvsMultiGpuShardedMergeMode`	Sharded merge mode
`n_rows_per_batch`	`int64_t`	Number of rows per batch

cuvsMultiGpuIvfPqSearchParamsCreate

Allocate Multi-GPU IVF-PQ search params, and populate with default values

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqSearchParamsCreate(cuvsMultiGpuIvfPqSearchParams_t* params);

Parameters

Name	Direction	Type	Description
`params`	in	`cuvsMultiGpuIvfPqSearchParams_t*`	cuvsMultiGpuIvfPqSearchParams_t to allocate

Returns

CUVS_EXPORT cuvsError_t

cuvsMultiGpuIvfPqSearchParamsDestroy

De-allocate Multi-GPU IVF-PQ search params

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqSearchParamsDestroy(cuvsMultiGpuIvfPqSearchParams_t params);

Parameters

Name	Direction	Type	Description
`params`	in	`cuvsMultiGpuIvfPqSearchParams_t`

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index

cuvsMultiGpuIvfPqIndex

Struct to hold address of cuvs::neighbors::mg_index<ivf_pq::index> and its active trained

dtype

1 typedef struct { ... } cuvsMultiGpuIvfPqIndex;

Fields

Name	Type	Description
`addr`	`uintptr_t`
`dtype`	`DLDataType`

cuvsMultiGpuIvfPqIndexCreate

Allocate Multi-GPU IVF-PQ index

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqIndexCreate(cuvsMultiGpuIvfPqIndex_t* index);

Parameters

Name	Direction	Type	Description
`index`	in	`cuvsMultiGpuIvfPqIndex_t*`	cuvsMultiGpuIvfPqIndex_t to allocate

Returns

CUVS_EXPORT cuvsError_t

cuvsMultiGpuIvfPqIndexDestroy

De-allocate Multi-GPU IVF-PQ index

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqIndexDestroy(cuvsMultiGpuIvfPqIndex_t index);

Parameters

Name	Direction	Type	Description
`index`	in	`cuvsMultiGpuIvfPqIndex_t`	cuvsMultiGpuIvfPqIndex_t to de-allocate

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index build

cuvsMultiGpuIvfPqBuild

Build a Multi-GPU IVF-PQ index

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqBuild(cuvsResources_t res,
2 cuvsMultiGpuIvfPqIndexParams_t params,
3 DLManagedTensor* dataset_tensor,
4 cuvsMultiGpuIvfPqIndex_t index);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`params`	in	`cuvsMultiGpuIvfPqIndexParams_t`	Multi-GPU IVF-PQ index parameters
`dataset_tensor`	in	`DLManagedTensor*`	DLManagedTensor* training dataset
`index`	out	`cuvsMultiGpuIvfPqIndex_t`	Multi-GPU IVF-PQ index

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index search

cuvsMultiGpuIvfPqSearch

Search a Multi-GPU IVF-PQ index

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqSearch(cuvsResources_t res,
2 cuvsMultiGpuIvfPqSearchParams_t params,
3 cuvsMultiGpuIvfPqIndex_t index,
4 DLManagedTensor* queries_tensor,
5 DLManagedTensor* neighbors_tensor,
6 DLManagedTensor* distances_tensor);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`params`	in	`cuvsMultiGpuIvfPqSearchParams_t`	Multi-GPU IVF-PQ search parameters
`index`	in	`cuvsMultiGpuIvfPqIndex_t`	Multi-GPU IVF-PQ index
`queries_tensor`	in	`DLManagedTensor*`	DLManagedTensor* queries dataset
`neighbors_tensor`	out	`DLManagedTensor*`	DLManagedTensor* output neighbors
`distances_tensor`	out	`DLManagedTensor*`	DLManagedTensor* output distances

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index extend

cuvsMultiGpuIvfPqExtend

Extend a Multi-GPU IVF-PQ index

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqExtend(cuvsResources_t res,
2 cuvsMultiGpuIvfPqIndex_t index,
3 DLManagedTensor* new_vectors_tensor,
4 DLManagedTensor* new_indices_tensor);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`index`	in,out	`cuvsMultiGpuIvfPqIndex_t`	Multi-GPU IVF-PQ index to extend
`new_vectors_tensor`	in	`DLManagedTensor*`	DLManagedTensor* new vectors to add
`new_indices_tensor`	in	`DLManagedTensor*`	DLManagedTensor* new indices (optional, can be NULL)

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index serialize

cuvsMultiGpuIvfPqSerialize

Serialize a Multi-GPU IVF-PQ index to file

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqSerialize(cuvsResources_t res,
2 cuvsMultiGpuIvfPqIndex_t index,
3 const char* filename);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`index`	in	`cuvsMultiGpuIvfPqIndex_t`	Multi-GPU IVF-PQ index to serialize
`filename`	in	`const char*`	Path to the output file

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index deserialize

cuvsMultiGpuIvfPqDeserialize

Deserialize a Multi-GPU IVF-PQ index from file

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqDeserialize(cuvsResources_t res,
2 const char* filename,
3 cuvsMultiGpuIvfPqIndex_t index);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`filename`	in	`const char*`	Path to the input file
`index`	out	`cuvsMultiGpuIvfPqIndex_t`	Multi-GPU IVF-PQ index

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-PQ index distribute

cuvsMultiGpuIvfPqDistribute

Distribute a local IVF-PQ index to create a Multi-GPU index

1 CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfPqDistribute(cuvsResources_t res,
2 const char* filename,
3 cuvsMultiGpuIvfPqIndex_t index);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`filename`	in	`const char*`	Path to the local index file
`index`	out	`cuvsMultiGpuIvfPqIndex_t`	Multi-GPU IVF-PQ index

Returns

CUVS_EXPORT cuvsError_t