Skip to main content

cuvsCagraBuild

Function cuvsCagraBuild 

Source
pub unsafe extern "C" fn cuvsCagraBuild(
    res: cuvsResources_t,
    params: cuvsCagraIndexParams_t,
    dataset: *mut DLManagedTensor,
    index: cuvsCagraIndex_t,
) -> cuvsError_t
Expand description

@brief Build a CAGRA index with a DLManagedTensor which has underlying DLDeviceType equal to kDLCUDA, kDLCUDAHost, kDLCUDAManaged, or kDLCPU. Also, acceptable underlying types are: 1. kDLDataType.code == kDLFloat and kDLDataType.bits = 32 2. kDLDataType.code == kDLFloat and kDLDataType.bits = 16 3. kDLDataType.code == kDLInt and kDLDataType.bits = 8 4. kDLDataType.code == kDLUInt and kDLDataType.bits = 8

@code {.c} #include <cuvs/core/c_api.h> #include <cuvs/neighbors/cagra.h>

// Create cuvsResources_t cuvsResources_t res; cuvsError_t res_create_status = cuvsResourcesCreate(&res);

// Assume a populated DLManagedTensor type here DLManagedTensor dataset;

// Create default index params cuvsCagraIndexParams_t params; cuvsError_t params_create_status = cuvsCagraIndexParamsCreate(&params);

// Create CAGRA index cuvsCagraIndex_t index; cuvsError_t index_create_status = cuvsCagraIndexCreate(&index);

// Build the CAGRA Index cuvsError_t build_status = cuvsCagraBuild(res, params, &dataset, index);

// de-allocate params, index and res cuvsError_t params_destroy_status = cuvsCagraIndexParamsDestroy(params); cuvsError_t index_destroy_status = cuvsCagraIndexDestroy(index); cuvsError_t res_destroy_status = cuvsResourcesDestroy(res); @endcode

@param[in] res cuvsResources_t opaque C handle @param[in] params cuvsCagraIndexParams_t used to build CAGRA index @param[in] dataset DLManagedTensor* training dataset @param[inout] index cuvsCagraIndex_t Newly built CAGRA index. This index needs to be already created with cuvsCagraIndexCreate. @return cuvsError_t