Skip to main content

cuvsTieredIndexBuild

Function cuvsTieredIndexBuild 

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

@defgroup tieredindex_c_index_build Tiered index build @{ / /** @brief Build a TieredIndex 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

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

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

// Assume a populated DLManagedTensor type here DLManagedTensor dataset;

// Create TieredIndex index cuvsTieredIndex_t index; cuvsError_t index_create_status = cuvsTieredIndexCreate(&index);

// Create default index params cuvsTieredIndexParams_t index_params; cuvsError_t params_create_status = cuvsTieredIndexParamsCreate(&index_params);

// Build the TieredIndex Index cuvsError_t build_status = cuvsTieredIndexBuild(res, index_params, &dataset_tensor, index);

// de-allocate index and res cuvsError_t index_destroy_status = cuvsTieredIndexDestroy(index); cuvsError_t res_destroy_status = cuvsResourcesDestroy(res); @endcode

@param[in] res cuvsResources_t opaque C handle @param[in] dataset DLManagedTensor* training dataset @param[in] index_params Index parameters to use when building the index @param[out] index cuvsTieredIndex_t Newly built TieredIndex index @return cuvsError_t