@@ -23,18 +23,18 @@ extern "C" {
2323 * @brief A type for specifying how PQ codebooks are created
2424 *
2525 */
26- enum cuvsCodebookGen {
27- CUVS_CODEBOOK_GEN_PER_SUBSPACE = 0 ,
28- CUVS_CODEBOOK_GEN_PER_CLUSTER = 1 ,
26+ enum cuvsIvfPqCodebookGen {
27+ CUVS_IVF_PQ_CODEBOOK_GEN_PER_SUBSPACE = 0 ,
28+ CUVS_IVF_PQ_CODEBOOK_GEN_PER_CLUSTER = 1 ,
2929};
3030
3131/**
3232 * @brief A type for specifying the memory layout of IVF-PQ list data
3333 *
3434 */
35- enum cuvsListLayout {
36- CUVS_LIST_LAYOUT_FLAT = 0 ,
37- CUVS_LIST_LAYOUT_INTERLEAVED = 1 ,
35+ enum cuvsIvfPqListLayout {
36+ CUVS_IVF_PQ_LIST_LAYOUT_FLAT = 0 ,
37+ CUVS_IVF_PQ_LIST_LAYOUT_INTERLEAVED = 1 ,
3838};
3939
4040/**
@@ -89,7 +89,7 @@ struct cuvsIvfPqIndexParams {
8989 */
9090 uint32_t pq_dim ;
9191 /** How PQ codebooks are created. */
92- enum cuvsCodebookGen codebook_kind ;
92+ enum cuvsIvfPqCodebookGen codebook_kind ;
9393 /**
9494 * Apply a random rotation matrix on the input data and queries even if `dim % pq_dim == 0`.
9595 *
@@ -126,11 +126,11 @@ struct cuvsIvfPqIndexParams {
126126 /**
127127 * Memory layout of the IVF-PQ list data.
128128 *
129- * - CUVS_LIST_LAYOUT_FLAT : Codes are stored contiguously, one vector's codes after another.
130- * - CUVS_LIST_LAYOUT_INTERLEAVED : Codes are interleaved for optimized search performance.
129+ * - CUVS_IVF_PQ_LIST_LAYOUT_FLAT : Codes are stored contiguously, one vector's codes after another.
130+ * - CUVS_IVF_PQ_LIST_LAYOUT_INTERLEAVED : Codes are interleaved for optimized search performance.
131131 * This is the default and recommended for search workloads.
132132 */
133- enum cuvsListLayout codes_layout ;
133+ enum cuvsIvfPqListLayout codes_layout ;
134134};
135135
136136typedef struct cuvsIvfPqIndexParams * cuvsIvfPqIndexParams_t ;
@@ -311,8 +311,8 @@ cuvsError_t cuvsIvfPqIndexGetCentersPadded(cuvsIvfPqIndex_t index, DLManagedTens
311311/**
312312 * @brief Get the PQ cluster centers
313313 *
314- * - CUVS_CODEBOOK_GEN_PER_SUBSPACE : [pq_dim , pq_len, pq_book_size]
315- * - CUVS_CODEBOOK_GEN_PER_CLUSTER : [n_lists, pq_len, pq_book_size]
314+ * - CUVS_IVF_PQ_CODEBOOK_GEN_PER_SUBSPACE : [pq_dim , pq_len, pq_book_size]
315+ * - CUVS_IVF_PQ_CODEBOOK_GEN_PER_CLUSTER : [n_lists, pq_len, pq_book_size]
316316 *
317317 * @param[in] index cuvsIvfPqIndex_t Built Ivf-Pq index
318318 * @param[out] pq_centers Output tensor that will be populated with a non-owning view of the data
@@ -460,8 +460,8 @@ cuvsError_t cuvsIvfPqBuild(cuvsResources_t res,
460460 * matrices)
461461 * @param[in] dim dimensionality of the input data
462462 * @param[in] pq_centers PQ codebook on device memory with required shape:
463- * - codebook_kind CUVS_CODEBOOK_GEN_PER_SUBSPACE : [pq_dim, pq_len, pq_book_size]
464- * - codebook_kind CUVS_CODEBOOK_GEN_PER_CLUSTER : [n_lists, pq_len, pq_book_size]
463+ * - codebook_kind CUVS_IVF_PQ_CODEBOOK_GEN_PER_SUBSPACE : [pq_dim, pq_len, pq_book_size]
464+ * - codebook_kind CUVS_IVF_PQ_CODEBOOK_GEN_PER_CLUSTER : [n_lists, pq_len, pq_book_size]
465465 * @param[in] centers Cluster centers in the original space [n_lists, dim_ext]
466466 * where dim_ext = round_up(dim + 1, 8)
467467 * @param[in] centers_rot Rotated cluster centers [n_lists, rot_dim]
0 commit comments