fix doxygen and add docs

rapidsai · Nov 9, 2023 · aa22782 · aa22782
1 parent c987055
commit aa22782
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/cpp/include/raft/neighbors/cagra_serialize.cuh b/cpp/include/raft/neighbors/cagra_serialize.cuh
@@ -115,7 +115,6 @@ void serialize(raft::resources const& handle,
  * @param[in] handle the raft handle
  * @param[in] os output stream
  * @param[in] index CAGRA index
- * @param[in] include_dataset Whether or not to write out the dataset to the file.
  *
  */
 template <typename T, typename IdxT>
@@ -148,7 +147,6 @@ void serialize_to_hnswlib(raft::resources const& handle,
  * @param[in] handle the raft handle
  * @param[in] filename the file name for saving the index
  * @param[in] index CAGRA index
- * @param[in] include_dataset Whether or not to write out the dataset to the file.
  *
  */
 template <typename T, typename IdxT>

diff --git a/docs/source/ann_benchmarks_param_tuning.md b/docs/source/ann_benchmarks_param_tuning.md
@@ -46,7 +46,7 @@ IVF-pq is an inverted-file index, which partitions the vectors into a series of
 
 
 ### `raft_cagra`
-CAGRA uses a graph-based index, which creates an intermediate, approximate kNN graph using IVF-PQ and then further refining and optimizing to create a final kNN graph. This kNN graph is used by CAGRA as an index for search.
+<a id='raft-cagra'></a>CAGRA uses a graph-based index, which creates an intermediate, approximate kNN graph using IVF-PQ and then further refining and optimizing to create a final kNN graph. This kNN graph is used by CAGRA as an index for search.
 
 | Parameter                   | Type           | Required | Data Type                  | Default | Description                                                                                                                                                                       |
 |-----------------------------|----------------|----------|----------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -83,6 +83,13 @@ Alternatively, if `graph_build_algo == "NN_DESCENT"`, then we can customize the
 | `nn_descent_max_iterations`          | `build_param`  | N        | Positive Integer>0         | 20 | Alias for `nn_descent_niter` |
 | `nn_descent_termination_threshold`          | `build_param`  | N        | Positive float>0         | 0.0001 | Termination threshold for NN descent. |
 
+### `raft_cagra_hnswlib`
+This is a benchmark that enables interoperability between `CAGRA` built `HNSW` search. It uses the `CAGRA` built graph as the base layer of an `hnswlib` index to search queries only within the base layer (this is enabled with a simple patch to `hnswlib`).
+
+`build_param` : Same as `build_param` of [CAGRA](#raft-cagra)
+
+`search_param` : Same as `search_param` of [hnswlib](#hnswlib)
+
 ## FAISS Indexes
 
 ### `faiss_gpu_flat`
@@ -152,7 +159,7 @@ Use FAISS IVF-PQ index on CPU
 
 
 ## HNSW
-
+<a id='hnswlib'></a>
 ### `hnswlib`
 
 | Parameter        | Type            | Required | Data Type                            | Default | Description                                                                                                                                                                                                                                                                                       |