Neighbors Multi GPU IVF Flat

Source header: cuvs/neighbors/mg_ivf_flat.h

Multi-GPU IVF-Flat index build parameters

cuvsMultiGpuIvfFlatIndexParams

Multi-GPU parameters to build IVF-Flat Index

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

1 struct cuvsMultiGpuIvfFlatIndexParams {
2   cuvsIvfFlatIndexParams_t base_params;
3   cuvsMultiGpuDistributionMode mode;
4 };

Fields

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

cuvsMultiGpuIvfFlatIndexParamsCreate

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

1 cuvsError_t cuvsMultiGpuIvfFlatIndexParamsCreate(cuvsMultiGpuIvfFlatIndexParams_t* index_params);

Parameters

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

Returns

cuvsError_t

cuvsMultiGpuIvfFlatIndexParamsDestroy

De-allocate Multi-GPU IVF-Flat Index params

1 cuvsError_t cuvsMultiGpuIvfFlatIndexParamsDestroy(cuvsMultiGpuIvfFlatIndexParams_t index_params);

Parameters

Name	Direction	Type	Description
`index_params`	in	`cuvsMultiGpuIvfFlatIndexParams_t`

Returns

cuvsError_t

Multi-GPU IVF-Flat index search parameters

cuvsMultiGpuIvfFlatSearchParams

Multi-GPU parameters to search IVF-Flat index

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

1 struct cuvsMultiGpuIvfFlatSearchParams {
2   cuvsIvfFlatSearchParams_t base_params;
3   cuvsMultiGpuReplicatedSearchMode search_mode;
4   cuvsMultiGpuShardedMergeMode merge_mode;
5   int64_t n_rows_per_batch;
6 };

Fields

Name	Type	Description
`base_params`	`cuvsIvfFlatSearchParams_t`	Base IVF-Flat 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

cuvsMultiGpuIvfFlatSearchParamsCreate

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

1 cuvsError_t cuvsMultiGpuIvfFlatSearchParamsCreate(cuvsMultiGpuIvfFlatSearchParams_t* params);

Parameters

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

Returns

cuvsError_t

cuvsMultiGpuIvfFlatSearchParamsDestroy

De-allocate Multi-GPU IVF-Flat search params

1 cuvsError_t cuvsMultiGpuIvfFlatSearchParamsDestroy(cuvsMultiGpuIvfFlatSearchParams_t params);

Parameters

Name	Direction	Type	Description
`params`	in	`cuvsMultiGpuIvfFlatSearchParams_t`

Returns

cuvsError_t

Multi-GPU IVF-Flat index

cuvsMultiGpuIvfFlatIndex

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

1 typedef struct {
2   uintptr_t addr;
3   DLDataType dtype;
4 } cuvsMultiGpuIvfFlatIndex;

Fields

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

cuvsMultiGpuIvfFlatIndexCreate

Allocate Multi-GPU IVF-Flat index

1 cuvsError_t cuvsMultiGpuIvfFlatIndexCreate(cuvsMultiGpuIvfFlatIndex_t* index);

Parameters

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

Returns

cuvsError_t

cuvsMultiGpuIvfFlatIndexDestroy

De-allocate Multi-GPU IVF-Flat index

1 cuvsError_t cuvsMultiGpuIvfFlatIndexDestroy(cuvsMultiGpuIvfFlatIndex_t index);

Parameters

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

Returns

cuvsError_t

Multi-GPU IVF-Flat index build

cuvsMultiGpuIvfFlatBuild

Build a Multi-GPU IVF-Flat index

1 cuvsError_t cuvsMultiGpuIvfFlatBuild(cuvsResources_t res,
2 cuvsMultiGpuIvfFlatIndexParams_t params,
3 DLManagedTensor* dataset_tensor,
4 cuvsMultiGpuIvfFlatIndex_t index);

Parameters

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

Returns

cuvsError_t

Multi-GPU IVF-Flat index search

cuvsMultiGpuIvfFlatSearch

Search a Multi-GPU IVF-Flat index

1 cuvsError_t cuvsMultiGpuIvfFlatSearch(cuvsResources_t res,
2 cuvsMultiGpuIvfFlatSearchParams_t params,
3 cuvsMultiGpuIvfFlatIndex_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	`cuvsMultiGpuIvfFlatSearchParams_t`	Multi-GPU IVF-Flat search parameters
`index`	in	`cuvsMultiGpuIvfFlatIndex_t`	Multi-GPU IVF-Flat index
`queries_tensor`	in	`DLManagedTensor*`	DLManagedTensor* queries dataset
`neighbors_tensor`	out	`DLManagedTensor*`	DLManagedTensor* output neighbors
`distances_tensor`	out	`DLManagedTensor*`	DLManagedTensor* output distances

Returns

cuvsError_t

Multi-GPU IVF-Flat index extend

cuvsMultiGpuIvfFlatExtend

Extend a Multi-GPU IVF-Flat index

1 cuvsError_t cuvsMultiGpuIvfFlatExtend(cuvsResources_t res,
2 cuvsMultiGpuIvfFlatIndex_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	`cuvsMultiGpuIvfFlatIndex_t`	Multi-GPU IVF-Flat 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

cuvsError_t

Multi-GPU IVF-Flat index serialize

cuvsMultiGpuIvfFlatSerialize

Serialize a Multi-GPU IVF-Flat index to file

1 cuvsError_t cuvsMultiGpuIvfFlatSerialize(cuvsResources_t res,
2 cuvsMultiGpuIvfFlatIndex_t index,
3 const char* filename);

Parameters

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

Returns

cuvsError_t

Multi-GPU IVF-Flat index deserialize

cuvsMultiGpuIvfFlatDeserialize

Deserialize a Multi-GPU IVF-Flat index from file

1 cuvsError_t cuvsMultiGpuIvfFlatDeserialize(cuvsResources_t res,
2 const char* filename,
3 cuvsMultiGpuIvfFlatIndex_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	`cuvsMultiGpuIvfFlatIndex_t`	Multi-GPU IVF-Flat index

Returns

cuvsError_t

Multi-GPU IVF-Flat index distribute

cuvsMultiGpuIvfFlatDistribute

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

1 cuvsError_t cuvsMultiGpuIvfFlatDistribute(cuvsResources_t res,
2 const char* filename,
3 cuvsMultiGpuIvfFlatIndex_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	`cuvsMultiGpuIvfFlatIndex_t`	Multi-GPU IVF-Flat index

Returns

cuvsError_t