Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
viclafargue committed Mar 14, 2023
1 parent 6e34d8a commit a1d8cee
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
10 changes: 4 additions & 6 deletions cpp/include/raft/neighbors/ivf_flat.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ namespace detail = raft::spatial::knn::ivf_flat::detail;
* @return the constructed ivf-flat index
*/
template <typename T, typename IdxT>
auto build(raft::device_resources const& handle,
const index_params& params,
raft::device_matrix_view<const T, IdxT, row_major> dataset) -> index<T, IdxT>
index<T, IdxT> build(raft::device_resources const& handle,
const index_params& params,
raft::device_matrix_view<const T, IdxT, row_major> dataset)
{
IdxT n_rows = dataset.extent(0);
IdxT dim = dataset.extent(1);
Expand Down Expand Up @@ -232,7 +232,7 @@ void search(raft::device_resources const& handle,
handle.get_workspace_resource());
}

/** @} */
/** @} */ // end group ivf_flat

/**
* @brief Build the index from the dataset for efficient search.
Expand Down Expand Up @@ -276,8 +276,6 @@ auto build(raft::device_resources const& handle,
return detail::build(handle, params, dataset, n_rows, dim);
}

/** @} */ // end group ivf_flat

/**
* @brief Build a new index containing the data of the original plus new extra vectors.
*
Expand Down
7 changes: 3 additions & 4 deletions cpp/include/raft/neighbors/ivf_pq.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ namespace raft::neighbors::ivf_pq {
* @return the constructed ivf-pq index
*/
template <typename T, typename IdxT = uint32_t>
auto build(raft::device_resources const& handle,
const index_params& params,
raft::device_matrix_view<const T, IdxT, row_major> dataset) -> index<IdxT>
index<IdxT> build(raft::device_resources const& handle,
const index_params& params,
raft::device_matrix_view<const T, IdxT, row_major> dataset)
{
IdxT n_rows = dataset.extent(0);
IdxT dim = dataset.extent(1);
Expand Down Expand Up @@ -284,7 +284,6 @@ auto extend(raft::device_resources const& handle,
* @param[in] new_indices a device/host pointer to a vector of indices [n_rows].
* If the original index is empty (`index.size() == 0`), you can pass `nullptr`
* here to imply a continuous range `[0...n_rows)`.
* @param[inout] idx
* @param n_rows the number of samples
*/
template <typename T, typename IdxT>
Expand Down
2 changes: 0 additions & 2 deletions cpp/include/raft/neighbors/ivf_pq_serialize.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ namespace raft::neighbors::ivf_pq {
* @param[in] os output stream
* @param[in] index IVF-PQ index
*
* @return raft::neighbors::ivf_pq::index<IdxT>
*/
template <typename IdxT>
void serialize(raft::device_resources const& handle, std::ostream& os, const index<IdxT>& index)
Expand Down Expand Up @@ -77,7 +76,6 @@ void serialize(raft::device_resources const& handle, std::ostream& os, const ind
* @param[in] filename the file name for saving the index
* @param[in] index IVF-PQ index
*
* @return raft::neighbors::ivf_pq::index<IdxT>
*/
template <typename IdxT>
void serialize(raft::device_resources const& handle,
Expand Down

0 comments on commit a1d8cee

Please sign in to comment.