Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Brute Force Index documentation fix #1944

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Brute Force Index documentation fix #1944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cpp/include/raft/neighbors/ball_cover-inl.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ namespace raft::neighbors::ball_cover {
* #include <raft/distance/distance_types.hpp>
* using namespace raft::neighbors;
*
* raft::raft::resources handle;
* raft::resources handle;
* ...
* auto metric = raft::distance::DistanceType::L2Expanded;
* BallCoverIndex index(handle, X, metric);
Expand Down Expand Up @@ -168,7 +168,7 @@ void all_knn_query(raft::resources const& handle,
* #include <raft/distance/distance_types.hpp>
* using namespace raft::neighbors;
*
* raft::raft::resources handle;
* raft::resources handle;
* ...
* auto metric = raft::distance::DistanceType::L2Expanded;
*
Expand Down Expand Up @@ -316,7 +316,7 @@ void knn_query(raft::resources const& handle,
* #include <raft/distance/distance_types.hpp>
* using namespace raft::neighbors;
*
* raft::raft::resources handle;
* raft::resources handle;
* ...
* auto metric = raft::distance::DistanceType::L2Expanded;
*
Expand Down
20 changes: 10 additions & 10 deletions cpp/include/raft/neighbors/brute_force-inl.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -59,7 +59,7 @@ namespace raft::neighbors::brute_force {
* #include <raft/neighbors/brute_force.cuh>
* using namespace raft::neighbors;
*
* raft::raft::resources handle;
* raft::resources handle;
* ...
* compute multiple knn graphs and aggregate row-wise
* (see detailed description above)
Expand Down Expand Up @@ -126,7 +126,7 @@ inline void knn_merge_parts(
* #include <raft/distance/distance_types.hpp>
* 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);
Expand Down Expand Up @@ -219,7 +219,7 @@ void knn(raft::resources const& handle,
* #include <raft/distance/distance_types.hpp>
* 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);
Expand Down
2 changes: 1 addition & 1 deletion cpp/include/raft/neighbors/brute_force_types.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

namespace raft::neighbors::brute_force {
/**
* @addtogroup brute_force
* @addtogroup brute_force_knn
* @{
*/

Expand Down