hipVS C API documentation

2026-01-06

3 min read time

Applies to Linux

• Core Routines
  • Resources Handle
    • cuvsResources_t
    • cuvsResourcesCreate()
    • cuvsResourcesDestroy()
    • cuvsStreamSet()
    • cuvsStreamGet()
    • cuvsStreamSync()
    • cuvsDeviceIdGet()
    • cuvsMultiGpuResourcesCreate()
    • cuvsMultiGpuResourcesCreateWithDeviceIds()
    • cuvsMultiGpuResourcesDestroy()
  • Error Handling
    • cuvsError_t
      • CUVS_ERROR
      • CUVS_SUCCESS
    • cuvsGetLastErrorText()
    • cuvsLogLastErrorText()
    • cuvsSetLastErrorText()
• Nearest Neighbors
  • Bruteforce
    • Index
      • cuvsBruteForceIndex_t
      • cuvsBruteForceIndexCreate()
      • cuvsBruteForceIndexDestroy()
      • cuvsBruteForceIndex
    • Index build
      • cuvsBruteForceBuild()
    • Index search
      • cuvsBruteForceSearch()
    • Index serialize
      • cuvsBruteForceSerialize()
      • cuvsBruteForceDeserialize()
  • IVF-Flat
    • Index build parameters
      • cuvsIvfFlatIndexParamsCreate()
      • cuvsIvfFlatIndexParamsDestroy()
      • cuvsIvfFlatIndexParams
    • Index search parameters
      • cuvsIvfFlatSearchParamsCreate()
      • cuvsIvfFlatSearchParamsDestroy()
      • cuvsIvfFlatSearchParams
    • Index
      • cuvsIvfFlatIndex_t
      • cuvsIvfFlatIndexCreate()
      • cuvsIvfFlatIndexDestroy()
      • cuvsIvfFlatIndexGetNLists()
      • cuvsIvfFlatIndexGetDim()
      • cuvsIvfFlatIndexGetCenters()
      • cuvsIvfFlatIndex
    • Index build
      • cuvsIvfFlatBuild()
    • Index search
      • cuvsIvfFlatSearch()
    • Index serialize
      • cuvsIvfFlatSerialize()
      • cuvsIvfFlatDeserialize()
  • IVF-PQ
    • Index build parameters
      • codebook_gen
      • cuvsIvfPqIndexParamsCreate()
      • cuvsIvfPqIndexParamsDestroy()
      • cuvsIvfPqIndexParams
    • Index search parameters
      • cuvsIvfPqSearchParamsCreate()
      • cuvsIvfPqSearchParamsDestroy()
      • cuvsIvfPqSearchParams
    • Index
      • cuvsIvfPqIndex_t
      • cuvsIvfPqIndexCreate()
      • cuvsIvfPqIndexDestroy()
      • cuvsIvfPqIndexGetNLists()
      • cuvsIvfPqIndexGetDim()
      • cuvsIvfPqIndexGetSize()
      • cuvsIvfPqIndexGetCenters()
      • cuvsIvfPqIndexGetPqCenters()
      • cuvsIvfPqIndex
    • Index build
      • cuvsIvfPqBuild()
    • Index search
      • cuvsIvfPqSearch()
    • Index serialize
      • cuvsIvfPqSerialize()
      • cuvsIvfPqDeserialize()
  • CAGRA
    • Index build parameters
      • cuvsCagraGraphBuildAlgo
      • cuvsCagraIndexParamsCreate()
      • cuvsCagraIndexParamsDestroy()
      • cuvsCagraCompressionParamsCreate()
      • cuvsCagraCompressionParamsDestroy()
      • cuvsCagraCompressionParams
      • cuvsIvfPqParams
      • cuvsCagraIndexParams
    • Index search parameters
      • cuvsCagraSearchAlgo
      • cuvsCagraHashMode
      • cuvsCagraSearchParamsCreate()
      • cuvsCagraSearchParamsDestroy()
      • cuvsCagraSearchParams
    • Index
      • cuvsCagraIndex_t
      • cuvsCagraIndexCreate()
      • cuvsCagraIndexDestroy()
      • cuvsCagraIndexGetDims()
      • cuvsCagraIndexGetSize()
      • cuvsCagraIndexGetGraphDegree()
      • cuvsCagraIndexGetDataset()
      • cuvsCagraIndexGetGraph()
      • cuvsCagraIndex
    • Index build
      • cuvsCagraBuild()
    • Index search
      • cuvsCagraSearch()
    • Index serialize
      • cuvsCagraSerialize()
      • cuvsCagraSerializeToHnswlib()
      • cuvsCagraDeserialize()
      • cuvsCagraIndexFromArgs()
      • cuvsCagraMerge()
  • HNSW
    • Index search parameters
      • cuvsHnswSearchParamsCreate()
      • cuvsHnswSearchParamsDestroy()
      • cuvsHnswSearchParams
    • Index
      • cuvsHnswIndex_t
      • cuvsHnswIndexCreate()
      • cuvsHnswIndexDestroy()
      • cuvsHnswIndex
    • Index extend parameters
      • cuvsHnswExtendParamsCreate()
      • cuvsHnswExtendParamsDestroy()
      • cuvsHnswExtendParams
    • Index extend
      • cuvsHnswExtend()
    • Index load
      • cuvsHnswFromCagra()
      • cuvsHnswFromCagraWithDataset()
    • Index search
      • cuvsHnswSearch()
    • Index serialize
      • cuvsHnswSerialize()
      • cuvsHnswDeserialize()
  • Multi-GPU Nearest Neighbors
  • Common Types and Enums
    • cuvsMultiGpuDistributionMode
      • CUVS_NEIGHBORS_MG_REPLICATED
      • CUVS_NEIGHBORS_MG_SHARDED
    • cuvsMultiGpuReplicatedSearchMode
      • CUVS_NEIGHBORS_MG_LOAD_BALANCER
      • CUVS_NEIGHBORS_MG_ROUND_ROBIN
    • cuvsMultiGpuShardedMergeMode
      • CUVS_NEIGHBORS_MG_MERGE_ON_ROOT_RANK
      • CUVS_NEIGHBORS_MG_TREE_MERGE
  • Multi-GPU IVF-Flat
    • IVF-Flat Index Build Parameters
      • cuvsMultiGpuIvfFlatIndexParamsCreate()
      • cuvsMultiGpuIvfFlatIndexParamsDestroy()
      • cuvsMultiGpuIvfFlatIndexParams
    • IVF-Flat Index Search Parameters
      • cuvsMultiGpuIvfFlatSearchParamsCreate()
      • cuvsMultiGpuIvfFlatSearchParamsDestroy()
      • cuvsMultiGpuIvfFlatSearchParams
    • IVF-Flat Index
      • cuvsMultiGpuIvfFlatIndex_t
      • cuvsMultiGpuIvfFlatIndexCreate()
      • cuvsMultiGpuIvfFlatIndexDestroy()
      • cuvsMultiGpuIvfFlatIndex
    • IVF-Flat Index Build
      • cuvsMultiGpuIvfFlatBuild()
    • IVF-Flat Index Search
      • cuvsMultiGpuIvfFlatSearch()
    • IVF-Flat Index Extend
      • cuvsMultiGpuIvfFlatExtend()
    • IVF-Flat Index Serialize
      • cuvsMultiGpuIvfFlatSerialize()
    • IVF-Flat Index Deserialize
      • cuvsMultiGpuIvfFlatDeserialize()
    • IVF-Flat Index Distribute
      • cuvsMultiGpuIvfFlatDistribute()
  • Multi-GPU IVF-PQ
    • IVF-PQ Index Build Parameters
      • cuvsMultiGpuIvfPqIndexParamsCreate()
      • cuvsMultiGpuIvfPqIndexParamsDestroy()
      • cuvsMultiGpuIvfPqIndexParams
    • IVF-PQ Index Search Parameters
      • cuvsMultiGpuIvfPqSearchParamsCreate()
      • cuvsMultiGpuIvfPqSearchParamsDestroy()
      • cuvsMultiGpuIvfPqSearchParams
    • IVF-PQ Index
      • cuvsMultiGpuIvfPqIndex_t
      • cuvsMultiGpuIvfPqIndexCreate()
      • cuvsMultiGpuIvfPqIndexDestroy()
      • cuvsMultiGpuIvfPqIndex
    • IVF-PQ Index Build
      • cuvsMultiGpuIvfPqBuild()
    • IVF-PQ Index Search
      • cuvsMultiGpuIvfPqSearch()
    • IVF-PQ Index Extend
      • cuvsMultiGpuIvfPqExtend()
    • IVF-PQ Index Serialize
      • cuvsMultiGpuIvfPqSerialize()
    • IVF-PQ Index Deserialize
      • cuvsMultiGpuIvfPqDeserialize()
    • IVF-PQ Index Distribute
      • cuvsMultiGpuIvfPqDistribute()
  • Multi-GPU CAGRA
    • CAGRA Index Build Parameters
      • cuvsMultiGpuCagraIndexParamsCreate()
      • cuvsMultiGpuCagraIndexParamsDestroy()
      • cuvsMultiGpuCagraIndexParams
    • CAGRA Index Search Parameters
      • cuvsMultiGpuCagraSearchParamsCreate()
      • cuvsMultiGpuCagraSearchParamsDestroy()
      • cuvsMultiGpuCagraSearchParams
    • CAGRA Index
      • cuvsMultiGpuCagraIndex_t
      • cuvsMultiGpuCagraIndexCreate()
      • cuvsMultiGpuCagraIndexDestroy()
      • cuvsMultiGpuCagraIndex
    • CAGRA Index Build
      • cuvsMultiGpuCagraBuild()
    • CAGRA Index Search
      • cuvsMultiGpuCagraSearch()
    • CAGRA Index Extend
      • cuvsMultiGpuCagraExtend()
    • CAGRA Index Serialize
      • cuvsMultiGpuCagraSerialize()
    • CAGRA Index Deserialize
      • cuvsMultiGpuCagraDeserialize()
    • CAGRA Index Distribute
      • cuvsMultiGpuCagraDistribute()
  • All-Neighbors
    • Build
      • cuvsAllNeighborsAlgo
      • cuvsAllNeighborsIndexParamsCreate()
      • cuvsAllNeighborsIndexParamsDestroy()
      • cuvsAllNeighborsBuild()
      • cuvsAllNeighborsIndexParams
  • Vamana
    • Index build parameters
      • cuvsVamanaIndexParamsCreate()
      • cuvsVamanaIndexParamsDestroy()
      • cuvsVamanaIndexParams
    • Index
      • cuvsVamanaIndex_t
      • cuvsVamanaIndexCreate()
      • cuvsVamanaIndexDestroy()
      • cuvsVamanaIndexGetDims()
      • cuvsVamanaIndex
    • Index build
      • cuvsVamanaBuild()
    • Index serialize
      • cuvsVamanaSerialize()
• Pairwise Distance
  • Pairwise Distance
    • cuvsPairwiseDistance()