Skip to main content

cuvsIvfFlatBuild

Function cuvsIvfFlatBuild 

Source
pub unsafe extern "C" fn cuvsIvfFlatBuild(
    res: cuvsResources_t,
    index_params: cuvsIvfFlatIndexParams_t,
    dataset: *mut DLManagedTensor,
    index: cuvsIvfFlatIndex_t,
) -> cuvsError_t
Expand description

@defgroup ivf_flat_c_index_build IVF-Flat index build @{ / /** @brief Build a IVF-Flat 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 == kDLInt and kDLDataType.bits = 8 3. kDLDataType.code == kDLUInt and kDLDataType.bits = 8

@code {.c} #include <cuvs/core/c_api.h> #include <cuvs/neighbors/ivf_flat.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 cuvsIvfFlatIndexParams_t index_params; cuvsError_t params_create_status = cuvsIvfFlatIndexParamsCreate(&index_params);

// Create IVF-Flat index cuvsIvfFlatIndex_t index; cuvsError_t index_create_status = cuvsIvfFlatIndexCreate(&index);

// Build the IVF-Flat Index cuvsError_t build_status = cuvsIvfFlatBuild(res, index_params, &dataset, index);

// de-allocate index_params, index and res cuvsError_t params_destroy_status = cuvsIvfFlatIndexParamsDestroy(index_params); cuvsError_t index_destroy_status = cuvsIvfFlatIndexDestroy(index); cuvsError_t res_destroy_status = cuvsResourcesDestroy(res); @endcode

@param[in] res cuvsResources_t opaque C handle @param[in] index_params cuvsIvfFlatIndexParams_t used to build IVF-Flat index @param[in] dataset DLManagedTensor* training dataset @param[out] index cuvsIvfFlatIndex_t Newly built IVF-Flat index @return cuvsError_t