Skip to content

Docs improvements #1992

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

Open
aamijar wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Docs improvements #1992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
61ceeaf
docs-improvements
aamijar Apr 6, 2026
bf9a029
add NN-Descent to C API
aamijar Apr 6, 2026
87a19b3
remove feature-matrix
aamijar Apr 6, 2026
2bbefcb
Merge branch 'main' into docs-improvements
aamijar Apr 6, 2026
c39ea3b
Merge branch 'main' into docs-improvements
aamijar Apr 8, 2026
3ffc9a2
Merge branch 'main' into docs-improvements
aamijar Apr 9, 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
56 changes: 28 additions & 28 deletions cpp/include/cuvs/neighbors/cagra.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2497,9 +2497,9 @@ auto merge(raft::resources const& res,
* @}
*/

/// \defgroup mg_cpp_index_build ANN MG index build
/// \defgroup mg_cpp_cagra_index_build ANN MG CAGRA index build

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_cagra_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2521,7 +2521,7 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const float, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<cagra::index<float, uint32_t>, float, uint32_t>;

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_cagra_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2543,7 +2543,7 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const half, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<cagra::index<half, uint32_t>, half, uint32_t>;

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_cagra_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2565,7 +2565,7 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const int8_t, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<cagra::index<int8_t, uint32_t>, int8_t, uint32_t>;

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_cagra_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2587,9 +2587,9 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const uint8_t, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<cagra::index<uint8_t, uint32_t>, uint8_t, uint32_t>;

/// \defgroup mg_cpp_index_extend ANN MG index extend
/// \defgroup mg_cpp_cagra_index_extend ANN MG CAGRA index extend

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_cagra_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2613,7 +2613,7 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const float, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const uint32_t, int64_t>> new_indices);

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_cagra_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2637,7 +2637,7 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const half, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const uint32_t, int64_t>> new_indices);

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_cagra_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2661,7 +2661,7 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const int8_t, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const uint32_t, int64_t>> new_indices);

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_cagra_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2685,9 +2685,9 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const uint8_t, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const uint32_t, int64_t>> new_indices);

/// \defgroup mg_cpp_index_search ANN MG index search
/// \defgroup mg_cpp_cagra_index_search ANN MG CAGRA index search

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2716,7 +2716,7 @@ void search(const raft::resources& clique,
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2745,7 +2745,7 @@ void search(const raft::resources& clique,
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2775,7 +2775,7 @@ void search(
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2805,7 +2805,7 @@ void search(
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2834,7 +2834,7 @@ void search(const raft::resources& clique,
raft::host_matrix_view<uint32_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2863,7 +2863,7 @@ void search(const raft::resources& clique,
raft::host_matrix_view<uint32_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2893,7 +2893,7 @@ void search(
raft::host_matrix_view<uint32_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_cagra_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2923,9 +2923,9 @@ void search(
raft::host_matrix_view<uint32_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \defgroup mg_cpp_serialize ANN MG index serialization
/// \defgroup mg_cpp_cagra_serialize ANN MG CAGRA index serialization

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_cagra_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2948,7 +2948,7 @@ void serialize(
const cuvs::neighbors::mg_index<cagra::index<float, uint32_t>, float, uint32_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_cagra_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2970,7 +2970,7 @@ void serialize(const raft::resources& clique,
const cuvs::neighbors::mg_index<cagra::index<half, uint32_t>, half, uint32_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_cagra_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2993,7 +2993,7 @@ void serialize(
const cuvs::neighbors::mg_index<cagra::index<int8_t, uint32_t>, int8_t, uint32_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_cagra_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -3016,9 +3016,9 @@ void serialize(
const cuvs::neighbors::mg_index<cagra::index<uint8_t, uint32_t>, uint8_t, uint32_t>& index,
const std::string& filename);

/// \defgroup mg_cpp_deserialize ANN MG index deserialization
/// \defgroup mg_cpp_cagra_deserialize ANN MG CAGRA index deserialization

/// \ingroup mg_cpp_deserialize
/// \ingroup mg_cpp_cagra_deserialize
/**
* @brief Deserializes a CAGRA multi-GPU index
*
Expand All @@ -3041,9 +3041,9 @@ template <typename T, typename IdxT>
auto deserialize(const raft::resources& clique, const std::string& filename)
-> cuvs::neighbors::mg_index<cagra::index<T, IdxT>, T, IdxT>;

/// \defgroup mg_cpp_distribute ANN MG local index distribution
/// \defgroup mg_cpp_cagra_distribute ANN MG CAGRA local index distribution

/// \ingroup mg_cpp_distribute
/// \ingroup mg_cpp_cagra_distribute
/**
* @brief Replicates a locally built and serialized CAGRA index to all GPUs to form a distributed
* multi-GPU index
Expand Down
48 changes: 25 additions & 23 deletions cpp/include/cuvs/neighbors/ivf_flat.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2019,9 +2019,9 @@ void deserialize(raft::resources const& handle,
* @}
*/

/// \defgroup mg_cpp_index_build ANN MG index build
/// \defgroup mg_cpp_ivf_flat_index_build ANN MG IVF-Flat index build

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_ivf_flat_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2043,7 +2043,7 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const float, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<ivf_flat::index<float, int64_t>, float, int64_t>;

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_ivf_flat_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2065,7 +2065,7 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const half, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<ivf_flat::index<half, int64_t>, half, int64_t>;

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_ivf_flat_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2087,7 +2087,7 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const int8_t, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<ivf_flat::index<int8_t, int64_t>, int8_t, int64_t>;

/// \ingroup mg_cpp_index_build
/// \ingroup mg_cpp_ivf_flat_index_build
/**
* @brief Builds a multi-GPU index
*
Expand All @@ -2109,9 +2109,9 @@ auto build(const raft::resources& clique,
raft::host_matrix_view<const uint8_t, int64_t, row_major> index_dataset)
-> cuvs::neighbors::mg_index<ivf_flat::index<uint8_t, int64_t>, uint8_t, int64_t>;

/// \defgroup mg_cpp_index_extend ANN MG index extend
/// \defgroup mg_cpp_ivf_flat_index_extend ANN MG IVF-Flat index extend

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_ivf_flat_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2135,7 +2135,7 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const float, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices);

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_ivf_flat_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2159,7 +2159,7 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const half, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices);

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_ivf_flat_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2183,7 +2183,7 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const int8_t, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices);

/// \ingroup mg_cpp_index_extend
/// \ingroup mg_cpp_ivf_flat_index_extend
/**
* @brief Extends a multi-GPU index
*
Expand All @@ -2207,9 +2207,9 @@ void extend(const raft::resources& clique,
raft::host_matrix_view<const uint8_t, int64_t, row_major> new_vectors,
std::optional<raft::host_vector_view<const int64_t, int64_t>> new_indices);

/// \defgroup mg_cpp_index_search ANN MG index search
/// \defgroup mg_cpp_ivf_flat_index_search ANN MG IVF-Flat index search

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_ivf_flat_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2238,7 +2238,7 @@ void search(const raft::resources& clique,
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_ivf_flat_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2267,7 +2267,7 @@ void search(const raft::resources& clique,
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_ivf_flat_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2297,7 +2297,7 @@ void search(
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \ingroup mg_cpp_index_search
/// \ingroup mg_cpp_ivf_flat_index_search
/**
* @brief Searches a multi-GPU index
*
Expand Down Expand Up @@ -2327,9 +2327,9 @@ void search(
raft::host_matrix_view<int64_t, int64_t, row_major> neighbors,
raft::host_matrix_view<float, int64_t, row_major> distances);

/// \defgroup mg_cpp_serialize ANN MG index serialization
/// \defgroup mg_cpp_ivf_flat_serialize ANN MG IVF-Flat index serialization

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_ivf_flat_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2352,7 +2352,7 @@ void serialize(
const cuvs::neighbors::mg_index<ivf_flat::index<float, int64_t>, float, int64_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_ivf_flat_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2375,7 +2375,7 @@ void serialize(
const cuvs::neighbors::mg_index<ivf_flat::index<half, int64_t>, half, int64_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_ivf_flat_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2398,7 +2398,7 @@ void serialize(
const cuvs::neighbors::mg_index<ivf_flat::index<int8_t, int64_t>, int8_t, int64_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_serialize
/// \ingroup mg_cpp_ivf_flat_serialize
/**
* @brief Serializes a multi-GPU index
*
Expand All @@ -2421,7 +2421,9 @@ void serialize(
const cuvs::neighbors::mg_index<ivf_flat::index<uint8_t, int64_t>, uint8_t, int64_t>& index,
const std::string& filename);

/// \ingroup mg_cpp_deserialize
/// \defgroup mg_cpp_ivf_flat_deserialize ANN MG IVF-Flat index deserialization

/// \ingroup mg_cpp_ivf_flat_deserialize
/**
* @brief Deserializes an IVF-Flat multi-GPU index
*
Expand All @@ -2444,9 +2446,9 @@ template <typename T, typename IdxT>
auto deserialize(const raft::resources& clique, const std::string& filename)
-> cuvs::neighbors::mg_index<ivf_flat::index<T, IdxT>, T, IdxT>;

/// \defgroup mg_cpp_distribute ANN MG local index distribution
/// \defgroup mg_cpp_ivf_flat_distribute ANN MG IVF-Flat local index distribution

/// \ingroup mg_cpp_distribute
/// \ingroup mg_cpp_ivf_flat_distribute
/**
* @brief Replicates a locally built and serialized IVF-Flat index to all GPUs to form a distributed
* multi-GPU index
Expand Down
Loading
Loading