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 { ... };

Fields

cuvsMultiGpuIvfFlatIndexParamsCreate

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

1
CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfFlatIndexParamsCreate(cuvsMultiGpuIvfFlatIndexParams_t* index_params);

Parameters

Returns

CUVS_EXPORT cuvsError_t

cuvsMultiGpuIvfFlatIndexParamsDestroy

De-allocate Multi-GPU IVF-Flat Index params

1
CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfFlatIndexParamsDestroy(cuvsMultiGpuIvfFlatIndexParams_t index_params);

Parameters

Returns

CUVS_EXPORT 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 { ... };

Fields

cuvsMultiGpuIvfFlatSearchParamsCreate

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

1
CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfFlatSearchParamsCreate(cuvsMultiGpuIvfFlatSearchParams_t* params);

Parameters

Returns

CUVS_EXPORT cuvsError_t

cuvsMultiGpuIvfFlatSearchParamsDestroy

De-allocate Multi-GPU IVF-Flat search params

1
CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfFlatSearchParamsDestroy(cuvsMultiGpuIvfFlatSearchParams_t params);

Parameters

Returns

CUVS_EXPORT 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 { ... } cuvsMultiGpuIvfFlatIndex;

Fields

cuvsMultiGpuIvfFlatIndexCreate

Allocate Multi-GPU IVF-Flat index

1
CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfFlatIndexCreate(cuvsMultiGpuIvfFlatIndex_t* index);

Parameters

Returns

CUVS_EXPORT cuvsError_t

cuvsMultiGpuIvfFlatIndexDestroy

De-allocate Multi-GPU IVF-Flat index

1
CUVS_EXPORT cuvsError_t cuvsMultiGpuIvfFlatIndexDestroy(cuvsMultiGpuIvfFlatIndex_t index);

Parameters

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-Flat index build

cuvsMultiGpuIvfFlatBuild

Build a Multi-GPU IVF-Flat index

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

Parameters

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-Flat index search

cuvsMultiGpuIvfFlatSearch

Search a Multi-GPU IVF-Flat index

1
CUVS_EXPORT 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

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-Flat index extend

cuvsMultiGpuIvfFlatExtend

Extend a Multi-GPU IVF-Flat index

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

Parameters

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-Flat index serialize

cuvsMultiGpuIvfFlatSerialize

Serialize a Multi-GPU IVF-Flat index to file

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

Parameters

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-Flat index deserialize

cuvsMultiGpuIvfFlatDeserialize

Deserialize a Multi-GPU IVF-Flat index from file

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

Parameters

Returns

CUVS_EXPORT cuvsError_t

Multi-GPU IVF-Flat index distribute

cuvsMultiGpuIvfFlatDistribute

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

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

Parameters

Returns

CUVS_EXPORT cuvsError_t