Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions cpp/include/cuvs/neighbors/cagra.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -897,6 +897,7 @@ struct index : cuvs::neighbors::index {
* - L2
* - InnerProduct (currently only supported with IVF-PQ as the build algorithm)
* - CosineExpanded
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -935,6 +936,7 @@ auto build(raft::resources const& res,
* - L2
* - InnerProduct (currently only supported with IVF-PQ as the build algorithm)
* - CosineExpanded
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -973,6 +975,7 @@ auto build(raft::resources const& res,
* - L2
* - InnerProduct (currently only supported with IVF-PQ as the build algorithm)
* - CosineExpanded (dataset norms are computed as float regardless of input data type)
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -1010,6 +1013,7 @@ auto build(raft::resources const& res,
* The following distance metrics are supported:
* - L2
* - CosineExpanded (dataset norms are computed as float regardless of input data type)
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -1047,6 +1051,9 @@ auto build(raft::resources const& res,
* The following distance metrics are supported:
* - L2
* - CosineExpanded (dataset norms are computed as float regardless of input data type)
* - L1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* - L1
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)

* - BitwiseHamming (currently only supported with NN-Descent and Iterative Search as the build
* algorithm, and only for int8_t and uint8_t data types)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -1085,6 +1092,9 @@ auto build(raft::resources const& res,
* - L2
* - InnerProduct (currently only supported with IVF-PQ as the build algorithm)
* - CosineExpanded (dataset norms are computed as float regardless of input data type)
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
* - BitwiseHamming (currently only supported with NN-Descent and Iterative Search as the build
* algorithm, and only for int8_t and uint8_t data types)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -1123,6 +1133,9 @@ auto build(raft::resources const& res,
* - L2
* - InnerProduct (currently only supported with IVF-PQ as the build algorithm)
* - CosineExpanded (dataset norms are computed as float regardless of input data type)
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
* - BitwiseHamming (currently only supported with NN-Descent and Iterative Search as the build
* algorithm, and only for int8_t and uint8_t data types)
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -1161,6 +1174,9 @@ auto build(raft::resources const& res,
* - L2
* - InnerProduct (currently only supported with IVF-PQ as the build algorithm)
* - CosineExpanded (dataset norms are computed as float regardless of input data type)
* - L1 (currently only supported with NN-Descent and Iterative Search as the build algorithm)
* - BitwiseHamming (currently only supported with NN-Descent and Iterative Search as the build
* algorithm, and only for int8_t and uint8_t data types)
*
* Usage example:
* @code{.cpp}
Expand Down
8 changes: 8 additions & 0 deletions cpp/include/cuvs/neighbors/nn_descent.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ struct index : cuvs::neighbors::index {
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -254,6 +255,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -292,6 +294,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -328,6 +331,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
*
* Usage example:
* @code{.cpp}
Expand Down Expand Up @@ -366,6 +370,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
* - BitwiseHamming
*
* Usage example:
Expand Down Expand Up @@ -403,6 +408,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
* - BitwiseHamming
*
* Usage example:
Expand Down Expand Up @@ -442,6 +448,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
* - BitwiseHamming
*
* Usage example:
Expand Down Expand Up @@ -479,6 +486,7 @@ auto build(raft::resources const& res,
* - L2SqrtExpanded
* - CosineExpanded
* - InnerProduct
* - L1
* - BitwiseHamming
*
* Usage example:
Expand Down
Loading
Loading