From d504795e9f2c02ab5485a040f4f683a1d76e7aab Mon Sep 17 00:00:00 2001 From: Micka Date: Wed, 1 Nov 2023 02:46:24 +0100 Subject: [PATCH] Brute Force Index documentation fix (#1944) Authors: - Micka (https://github.com/lowener) Approvers: - Corey J. Nolet (https://github.com/cjnolet) URL: https://github.com/rapidsai/raft/pull/1944 --- cpp/include/raft/neighbors/ball_cover-inl.cuh | 6 +++--- .../raft/neighbors/brute_force-inl.cuh | 20 +++++++++---------- .../raft/neighbors/brute_force_types.hpp | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/cpp/include/raft/neighbors/ball_cover-inl.cuh b/cpp/include/raft/neighbors/ball_cover-inl.cuh index c41ecf6ca2..d35c1dc614 100644 --- a/cpp/include/raft/neighbors/ball_cover-inl.cuh +++ b/cpp/include/raft/neighbors/ball_cover-inl.cuh @@ -44,7 +44,7 @@ namespace raft::neighbors::ball_cover { * #include * using namespace raft::neighbors; * - * raft::raft::resources handle; + * raft::resources handle; * ... * auto metric = raft::distance::DistanceType::L2Expanded; * BallCoverIndex index(handle, X, metric); @@ -168,7 +168,7 @@ void all_knn_query(raft::resources const& handle, * #include * using namespace raft::neighbors; * - * raft::raft::resources handle; + * raft::resources handle; * ... * auto metric = raft::distance::DistanceType::L2Expanded; * @@ -316,7 +316,7 @@ void knn_query(raft::resources const& handle, * #include * using namespace raft::neighbors; * - * raft::raft::resources handle; + * raft::resources handle; * ... * auto metric = raft::distance::DistanceType::L2Expanded; * diff --git a/cpp/include/raft/neighbors/brute_force-inl.cuh b/cpp/include/raft/neighbors/brute_force-inl.cuh index 88439a738b..52a40da272 100644 --- a/cpp/include/raft/neighbors/brute_force-inl.cuh +++ b/cpp/include/raft/neighbors/brute_force-inl.cuh @@ -34,13 +34,13 @@ namespace raft::neighbors::brute_force { * @brief Performs a k-select across several (contiguous) row-partitioned index/distance * matrices formatted like the following: * - * part1row1: k0, k1, k2, k3 - * part1row2: k0, k1, k2, k3 - * part1row3: k0, k1, k2, k3 - * part2row1: k0, k1, k2, k3 - * part2row2: k0, k1, k2, k3 - * part2row3: k0, k1, k2, k3 - * etc... + * part1row1: k0, k1, k2, k3 + * part1row2: k0, k1, k2, k3 + * part1row3: k0, k1, k2, k3 + * part2row1: k0, k1, k2, k3 + * part2row2: k0, k1, k2, k3 + * part2row3: k0, k1, k2, k3 + * etc... * * The example above shows what an aggregated index/distance matrix * would look like with two partitions when n_samples=3 and k=4. @@ -59,7 +59,7 @@ namespace raft::neighbors::brute_force { * #include * using namespace raft::neighbors; * - * raft::raft::resources handle; + * raft::resources handle; * ... * compute multiple knn graphs and aggregate row-wise * (see detailed description above) @@ -126,7 +126,7 @@ inline void knn_merge_parts( * #include * using namespace raft::neighbors; * - * raft::raft::resources handle; + * raft::resources handle; * ... * auto metric = raft::distance::DistanceType::L2SqrtExpanded; * brute_force::knn(handle, index, search, indices, distances, metric); @@ -219,7 +219,7 @@ void knn(raft::resources const& handle, * #include * using namespace raft::neighbors; * - * raft::raft::resources handle; + * raft::resources handle; * ... * auto metric = raft::distance::DistanceType::L2SqrtExpanded; * brute_force::fused_l2_knn(handle, index, search, indices, distances, metric); diff --git a/cpp/include/raft/neighbors/brute_force_types.hpp b/cpp/include/raft/neighbors/brute_force_types.hpp index 19dd6b8350..f7030503f1 100644 --- a/cpp/include/raft/neighbors/brute_force_types.hpp +++ b/cpp/include/raft/neighbors/brute_force_types.hpp @@ -30,7 +30,7 @@ namespace raft::neighbors::brute_force { /** - * @addtogroup brute_force + * @addtogroup brute_force_knn * @{ */