Skip to content

Commit fa29064

Browse files
committed
Update a comment
1 parent 1770971 commit fa29064

1 file changed

Lines changed: 24 additions & 16 deletions

File tree

cpp/include/cuvs/neighbors/cagra.hpp

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1751,8 +1751,9 @@ void search(raft::resources const& res,
17511751
* multi-partition implementation rather than the single-index search overloads above, and the
17521752
* behaviors are not guaranteed to be equivalent.
17531753
*
1754-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1755-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1754+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1755+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1756+
* partitions must be built on in-memory strided datasets.
17561757
*
17571758
* @param[in] res raft resources
17581759
* @param[in] params search parameters (shared across partitions)
@@ -1789,8 +1790,9 @@ void search(raft::resources const& res,
17891790
* multi-partition implementation rather than the single-index search overloads above, and the
17901791
* behaviors are not guaranteed to be equivalent.
17911792
*
1792-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1793-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1793+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1794+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1795+
* partitions must be built on in-memory strided datasets.
17941796
*
17951797
* @param[in] res raft resources
17961798
* @param[in] params search parameters (shared across partitions)
@@ -1827,8 +1829,9 @@ void search(raft::resources const& res,
18271829
* multi-partition implementation rather than the single-index search overloads above, and the
18281830
* behaviors are not guaranteed to be equivalent.
18291831
*
1830-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1831-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1832+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1833+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1834+
* partitions must be built on in-memory strided datasets.
18321835
*
18331836
* @param[in] res raft resources
18341837
* @param[in] params search parameters (shared across partitions)
@@ -1865,8 +1868,9 @@ void search(raft::resources const& res,
18651868
* multi-partition implementation rather than the single-index search overloads above, and the
18661869
* behaviors are not guaranteed to be equivalent.
18671870
*
1868-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1869-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1871+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1872+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1873+
* partitions must be built on in-memory strided datasets.
18701874
*
18711875
* @param[in] res raft resources
18721876
* @param[in] params search parameters (shared across partitions)
@@ -1903,8 +1907,9 @@ void search(raft::resources const& res,
19031907
* multi-partition implementation rather than the single-index search overloads above, and the
19041908
* behaviors are not guaranteed to be equivalent.
19051909
*
1906-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1907-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1910+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1911+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1912+
* partitions must be built on in-memory strided datasets.
19081913
*
19091914
* @param[in] res raft resources
19101915
* @param[in] params search parameters (shared across partitions)
@@ -1941,8 +1946,9 @@ void search(raft::resources const& res,
19411946
* multi-partition implementation rather than the single-index search overloads above, and the
19421947
* behaviors are not guaranteed to be equivalent.
19431948
*
1944-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1945-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1949+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1950+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1951+
* partitions must be built on in-memory strided datasets.
19461952
*
19471953
* @param[in] res raft resources
19481954
* @param[in] params search parameters (shared across partitions)
@@ -1979,8 +1985,9 @@ void search(raft::resources const& res,
19791985
* multi-partition implementation rather than the single-index search overloads above, and the
19801986
* behaviors are not guaranteed to be equivalent.
19811987
*
1982-
* @note All index partitions must use the same distance metric and graph degree, and be built on
1983-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
1988+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
1989+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
1990+
* partitions must be built on in-memory strided datasets.
19841991
*
19851992
* @param[in] res raft resources
19861993
* @param[in] params search parameters (shared across partitions)
@@ -2017,8 +2024,9 @@ void search(raft::resources const& res,
20172024
* multi-partition implementation rather than the single-index search overloads above, and the
20182025
* behaviors are not guaranteed to be equivalent.
20192026
*
2020-
* @note All index partitions must use the same distance metric and graph degree, and be built on
2021-
* in-memory strided (non-compressed) datasets. Partition sizes may differ.
2027+
* @note All index partitions must use the same distance metric and graph degree; partition sizes
2028+
* may differ. Compressed (VPQ) datasets are not currently supported in multi-partition search, so
2029+
* partitions must be built on in-memory strided datasets.
20222030
*
20232031
* @param[in] res raft resources
20242032
* @param[in] params search parameters (shared across partitions)

0 commit comments

Comments
 (0)