-
Notifications
You must be signed in to change notification settings - Fork 184
Common knn graph build params #949
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.
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
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
8a030ea
common knn graph build params
jinsolp debc28c
default
jinsolp b28a7c8
Merge branch 'branch-25.08' into common-knn-build
jinsolp 687b369
Merge branch 'branch-25.08' into common-knn-build
cjnolet 8e17210
Merge branch 'rapidsai:branch-25.08' into common-knn-build
jinsolp 68c9b9e
refinement rate
jinsolp 3ae8082
Merge branch 'branch-25.08' into common-knn-build
jinsolp 43d8dc2
Merge branch 'branch-25.08' into common-knn-build
jinsolp cace1a4
copyright
jinsolp 542b25b
Merge branch 'common-knn-build' of https://github.com/jinsolp/cuvs in…
jinsolp 3456f63
Merge branch 'branch-25.08' into common-knn-build
jinsolp a435955
Merge branch 'rapidsai:branch-25.08' into common-knn-build
jinsolp 97f900b
Merge branch 'branch-25.08' into common-knn-build
jinsolp e460c42
Merge branch 'branch-25.08' into common-knn-build
jinsolp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright (c) 2025, NVIDIA CORPORATION. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <cuvs/neighbors/ivf_pq.hpp> | ||
| #include <cuvs/neighbors/nn_descent.hpp> | ||
|
|
||
| namespace cuvs::neighbors { | ||
|
|
||
| /** | ||
| * @defgroup neighbors_build_algo Graph build algorithm types | ||
| * @{ | ||
| */ | ||
|
|
||
| enum GRAPH_BUILD_ALGO { BRUTE_FORCE = 0, IVF_PQ = 1, NN_DESCENT = 1 }; | ||
|
|
||
| namespace graph_build_params { | ||
|
|
||
| /** Specialized parameters utilizing IVF-PQ to build knn graph */ | ||
| struct ivf_pq_params { | ||
| cuvs::neighbors::ivf_pq::index_params build_params; | ||
| cuvs::neighbors::ivf_pq::search_params search_params; | ||
| float refinement_rate = 1.0; | ||
|
|
||
| ivf_pq_params() = default; | ||
|
|
||
| /** | ||
| * Set default parameters based on shape of the input dataset. | ||
| * Usage example: | ||
| * @code{.cpp} | ||
| * using namespace cuvs::neighbors; | ||
| * raft::resources res; | ||
| * // create index_params for a [N. D] dataset | ||
| * auto dataset = raft::make_device_matrix<float, int64_t>(res, N, D); | ||
| * auto pq_params = | ||
| * graph_build_params::ivf_pq_params(dataset.extents()); | ||
| * // modify/update index_params as needed | ||
| * pq_params.kmeans_trainset_fraction = 0.1; | ||
| * @endcode | ||
| */ | ||
| ivf_pq_params(raft::matrix_extent<int64_t> dataset_extents, | ||
| cuvs::distance::DistanceType metric = cuvs::distance::DistanceType::L2Expanded) | ||
| { | ||
| build_params = cuvs::neighbors::ivf_pq::index_params::from_dataset(dataset_extents, metric); | ||
|
|
||
| search_params = cuvs::neighbors::ivf_pq::search_params{}; | ||
| search_params.n_probes = std::max<uint32_t>(10, build_params.n_lists * 0.01); | ||
| search_params.lut_dtype = CUDA_R_16F; | ||
| search_params.internal_distance_dtype = CUDA_R_16F; | ||
| search_params.coarse_search_dtype = CUDA_R_16F; | ||
| search_params.max_internal_batch_size = 128 * 1024; | ||
|
|
||
| refinement_rate = 1; | ||
| } | ||
| }; | ||
|
|
||
| using nn_descent_params = cuvs::neighbors::nn_descent::index_params; | ||
|
|
||
| // **** Experimental **** | ||
| using iterative_search_params = cuvs::neighbors::search_params; | ||
| } // namespace graph_build_params | ||
|
|
||
| /** @} */ // end group neighbors_build_algo | ||
| } // namespace cuvs::neighbors | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cuVS isn't header-only, so the header files are very lightweight. Instead of introducing new headers for structs and enums, can we just reuse common.hpp?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
common.hpphas the baseindex_params(link), so declaringgraph_build_paramsin that file results in a circular dependency (because we make use ofivf_pq::index_paramsandnn_descent::index_paramsinside `graph_build_params)