Neighbors Multi GPU Cagra

Source header: cuvs/neighbors/mg_cagra.h

Multi-GPU CAGRA index build parameters

cuvsMultiGpuCagraIndexParams

Multi-GPU parameters to build CAGRA Index

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

1 struct cuvsMultiGpuCagraIndexParams {
2   cuvsCagraIndexParams_t base_params;
3   cuvsMultiGpuDistributionMode mode;
4 };

Fields

Name	Type	Description
`base_params`	`cuvsCagraIndexParams_t`	Base CAGRA index parameters
`mode`	`cuvsMultiGpuDistributionMode`	Distribution mode for multi-GPU setup

cuvsMultiGpuCagraIndexParamsCreate

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

1 cuvsError_t cuvsMultiGpuCagraIndexParamsCreate(cuvsMultiGpuCagraIndexParams_t* index_params);

Parameters

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

Returns

cuvsError_t

cuvsMultiGpuCagraIndexParamsDestroy

De-allocate Multi-GPU CAGRA Index params

1 cuvsError_t cuvsMultiGpuCagraIndexParamsDestroy(cuvsMultiGpuCagraIndexParams_t index_params);

Parameters

Name	Direction	Type	Description
`index_params`	in	`cuvsMultiGpuCagraIndexParams_t`

Returns

cuvsError_t

Multi-GPU CAGRA index search parameters

cuvsMultiGpuCagraSearchParams

Multi-GPU parameters to search CAGRA index

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

1 struct cuvsMultiGpuCagraSearchParams {
2   cuvsCagraSearchParams_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`	`cuvsCagraSearchParams_t`	Base CAGRA 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

cuvsMultiGpuCagraSearchParamsCreate

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

1 cuvsError_t cuvsMultiGpuCagraSearchParamsCreate(cuvsMultiGpuCagraSearchParams_t* params);

Parameters

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

Returns

cuvsError_t

cuvsMultiGpuCagraSearchParamsDestroy

De-allocate Multi-GPU CAGRA search params

1 cuvsError_t cuvsMultiGpuCagraSearchParamsDestroy(cuvsMultiGpuCagraSearchParams_t params);

Parameters

Name	Direction	Type	Description
`params`	in	`cuvsMultiGpuCagraSearchParams_t`

Returns

cuvsError_t

Multi-GPU CAGRA index

cuvsMultiGpuCagraIndex

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

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

Fields

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

cuvsMultiGpuCagraIndexCreate

Allocate Multi-GPU CAGRA index

1 cuvsError_t cuvsMultiGpuCagraIndexCreate(cuvsMultiGpuCagraIndex_t* index);

Parameters

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

Returns

cuvsError_t

cuvsMultiGpuCagraIndexDestroy

De-allocate Multi-GPU CAGRA index

1 cuvsError_t cuvsMultiGpuCagraIndexDestroy(cuvsMultiGpuCagraIndex_t index);

Parameters

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

Returns

cuvsError_t

Multi-GPU CAGRA index build

cuvsMultiGpuCagraBuild

Build a Multi-GPU CAGRA index

1 cuvsError_t cuvsMultiGpuCagraBuild(cuvsResources_t res,
2 cuvsMultiGpuCagraIndexParams_t params,
3 DLManagedTensor* dataset_tensor,
4 cuvsMultiGpuCagraIndex_t index);

Parameters

Name	Direction	Type	Description
`res`	in	`cuvsResources_t`	cuvsResources_t opaque C handle
`params`	in	`cuvsMultiGpuCagraIndexParams_t`	Multi-GPU CAGRA index parameters
`dataset_tensor`	in	`DLManagedTensor*`	DLManagedTensor* training dataset
`index`	out	`cuvsMultiGpuCagraIndex_t`	Multi-GPU CAGRA index

Returns

cuvsError_t

Multi-GPU CAGRA index search

cuvsMultiGpuCagraSearch

Search a Multi-GPU CAGRA index

1 cuvsError_t cuvsMultiGpuCagraSearch(cuvsResources_t res,
2 cuvsMultiGpuCagraSearchParams_t params,
3 cuvsMultiGpuCagraIndex_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	`cuvsMultiGpuCagraSearchParams_t`	Multi-GPU CAGRA search parameters
`index`	in	`cuvsMultiGpuCagraIndex_t`	Multi-GPU CAGRA 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 CAGRA index extend

cuvsMultiGpuCagraExtend

Extend a Multi-GPU CAGRA index

1 cuvsError_t cuvsMultiGpuCagraExtend(cuvsResources_t res,
2 cuvsMultiGpuCagraIndex_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	`cuvsMultiGpuCagraIndex_t`	Multi-GPU CAGRA 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 CAGRA index serialize

cuvsMultiGpuCagraSerialize

Serialize a Multi-GPU CAGRA index to file

1 cuvsError_t cuvsMultiGpuCagraSerialize(cuvsResources_t res,
2 cuvsMultiGpuCagraIndex_t index,
3 const char* filename);

Parameters

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

Returns

cuvsError_t

Multi-GPU CAGRA index deserialize

cuvsMultiGpuCagraDeserialize

Deserialize a Multi-GPU CAGRA index from file

1 cuvsError_t cuvsMultiGpuCagraDeserialize(cuvsResources_t res,
2 const char* filename,
3 cuvsMultiGpuCagraIndex_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	`cuvsMultiGpuCagraIndex_t`	Multi-GPU CAGRA index

Returns

cuvsError_t

Multi-GPU CAGRA index distribute

cuvsMultiGpuCagraDistribute

Distribute a local CAGRA index to create a Multi-GPU index

1 cuvsError_t cuvsMultiGpuCagraDistribute(cuvsResources_t res,
2 const char* filename,
3 cuvsMultiGpuCagraIndex_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	`cuvsMultiGpuCagraIndex_t`	Multi-GPU CAGRA index

Returns

cuvsError_t