Skip to content

Fix the build_knn_graph sample code #2339

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

Merged
rapids-bot merged 6 commits into from
Jul 23, 2026
Merged

Fix the build_knn_graph sample code #2339

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
24291fa
Fix the build_knn_graph sample code
enp1s0 Jul 21, 2026
28d9375
Update build_knn_graph sample code
enp1s0 Jul 21, 2026
5bee382
Merge branch 'main' into fix-build_knn_graph-sample
enp1s0 Jul 21, 2026
95f94dc
Merge branch 'main' into fix-build_knn_graph-sample
enp1s0 Jul 22, 2026
3ff8ee3
Merge branch 'main' into fix-build_knn_graph-sample
enp1s0 Jul 22, 2026
d47340d
Merge branch 'main' into fix-build_knn_graph-sample
enp1s0 Jul 23, 2026
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
72 changes: 36 additions & 36 deletions cpp/include/cuvs/neighbors/cagra.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3101,17 +3101,17 @@ auto distribute(const raft::resources& clique, const std::string& filename)
* Usage example:
* @code{.cpp}
* using namespace cuvs::neighbors;
* // use default index parameters based on shape of the dataset
* ivf_pq::index_params build_params = ivf_pq::index_params::from_dataset(dataset);
* ivf_pq::search_params search_params;
* auto knn_graph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 128);
* // raft::host_matrix_view<const float, int64_t, raft::row_major> dataset;
* auto metric = cuvs::distance::DistanceType::L2Expanded;
* auto build_params = cagra::graph_build_params::ivf_pq_params(dataset.extents(), metric);
* auto knn_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 128);
* // create knn graph
* cagra::build_knn_graph(res, dataset, knn_graph.view(), 2, build_params, search_params);
* auto optimized_gaph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 64);
* cagra::optimize(res, dataset, knn_graph.view(), optimized_graph.view());
* cagra::build_knn_graph(res, dataset, knn_graph.view(), build_params);
* auto optimized_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 64);
* cagra::helpers::optimize(res, knn_graph.view(), optimized_graph.view());
* // Construct an index from dataset and optimized knn_graph
* auto index = cagra::index<T, IdxT>(res, build_params.metric(), dataset,
* optimized_graph.view());
* auto index = cagra::index<float, uint32_t>(
* res, metric, dataset, raft::make_const_mdspan(optimized_graph.view()));
* @endcode
*
* @param[in] res raft resources
Expand Down Expand Up @@ -3141,17 +3141,17 @@ void build_knn_graph(raft::resources const& res,
* Usage example:
* @code{.cpp}
* using namespace cuvs::neighbors;
* // use default index parameters based on shape of the dataset
* ivf_pq::index_params build_params = ivf_pq::index_params::from_dataset(dataset);
* ivf_pq::search_params search_params;
* auto knn_graph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 128);
* // raft::host_matrix_view<const half, int64_t, raft::row_major> dataset;
* auto metric = cuvs::distance::DistanceType::L2Expanded;
* auto build_params = cagra::graph_build_params::ivf_pq_params(dataset.extents(), metric);
* auto knn_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 128);
* // create knn graph
* cagra::build_knn_graph(res, dataset, knn_graph.view(), 2, build_params, search_params);
* auto optimized_gaph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 64);
* cagra::optimize(res, dataset, knn_graph.view(), optimized_graph.view());
* cagra::build_knn_graph(res, dataset, knn_graph.view(), build_params);
* auto optimized_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 64);
* cagra::helpers::optimize(res, knn_graph.view(), optimized_graph.view());
* // Construct an index from dataset and optimized knn_graph
* auto index = cagra::index<T, IdxT>(res, build_params.metric(), dataset,
* optimized_graph.view());
* auto index = cagra::index<half, uint32_t>(
* res, metric, dataset, raft::make_const_mdspan(optimized_graph.view()));
* @endcode
*
* @param[in] res raft resources
Expand Down Expand Up @@ -3181,17 +3181,17 @@ void build_knn_graph(raft::resources const& res,
* Usage example:
* @code{.cpp}
* using namespace cuvs::neighbors;
* // use default index parameters based on shape of the dataset
* ivf_pq::index_params build_params = ivf_pq::index_params::from_dataset(dataset);
* ivf_pq::search_params search_params;
* auto knn_graph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 128);
* // raft::host_matrix_view<const int8_t, int64_t, raft::row_major> dataset;
* auto metric = cuvs::distance::DistanceType::L2Expanded;
* auto build_params = cagra::graph_build_params::ivf_pq_params(dataset.extents(), metric);
* auto knn_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 128);
* // create knn graph
* cagra::build_knn_graph(res, dataset, knn_graph.view(), 2, build_params, search_params);
* auto optimized_gaph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 64);
* cagra::optimize(res, dataset, knn_graph.view(), optimized_graph.view());
* cagra::build_knn_graph(res, dataset, knn_graph.view(), build_params);
* auto optimized_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 64);
* cagra::helpers::optimize(res, knn_graph.view(), optimized_graph.view());
* // Construct an index from dataset and optimized knn_graph
* auto index = cagra::index<T, IdxT>(res, build_params.metric(), dataset,
* optimized_graph.view());
* auto index = cagra::index<int8_t, uint32_t>(
* res, metric, dataset, raft::make_const_mdspan(optimized_graph.view()));
* @endcode
*
* @param[in] res raft resources
Expand Down Expand Up @@ -3221,17 +3221,17 @@ void build_knn_graph(raft::resources const& res,
* Usage example:
* @code{.cpp}
* using namespace cuvs::neighbors;
* // use default index parameters based on shape of the dataset
* ivf_pq::index_params build_params = ivf_pq::index_params::from_dataset(dataset);
* ivf_pq::search_params search_params;
* auto knn_graph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 128);
* // raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> dataset;
* auto metric = cuvs::distance::DistanceType::L2Expanded;
* auto build_params = cagra::graph_build_params::ivf_pq_params(dataset.extents(), metric);
* auto knn_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 128);
* // create knn graph
* cagra::build_knn_graph(res, dataset, knn_graph.view(), 2, build_params, search_params);
* auto optimized_gaph = raft::make_host_matrix<IdxT, IdxT>(dataset.extent(0), 64);
* cagra::optimize(res, dataset, knn_graph.view(), optimized_graph.view());
* cagra::build_knn_graph(res, dataset, knn_graph.view(), build_params);
* auto optimized_graph = raft::make_host_matrix<uint32_t, int64_t>(dataset.extent(0), 64);
* cagra::helpers::optimize(res, knn_graph.view(), optimized_graph.view());
* // Construct an index from dataset and optimized knn_graph
* auto index = cagra::index<T, IdxT>(res, build_params.metric(), dataset,
* optimized_graph.view());
* auto index = cagra::index<uint8_t, uint32_t>(
* res, metric, dataset, raft::make_const_mdspan(optimized_graph.view()));
* @endcode
*
* @param[in] res raft resources
Expand Down
Loading