Clean raft::neighbors comments (rapidsai#1665)

Rename outdated `raft::neighbors`, `raft::spatial`, `raft::sparse::distance` comments.

Authors:
  - Anupam (https://github.com/aamijar)

Approvers:
  - Corey J. Nolet (https://github.com/cjnolet)
  - Tarang Jain (https://github.com/tarang-jain)

URL: rapidsai#1665

Author: aamijar

cpp/include/cuvs/distance/distance.hpp

@@ -389,7 +389,7 @@ void pairwise_distance(
  *
  * auto out = raft::make_device_matrix<float>(handle, x_nrows, y_nrows);
  * auto metric = cuvs::distance::DistanceType::L2Expanded;
- * raft::sparse::distance::pairwise_distance(handle, x.view(), y.view(), out, metric);
+ * cuvs::pairwise_distance(handle, x.view(), y.view(), out, metric);
  * @endcode
  *
  * @param[in] handle raft::resources
@@ -429,7 +429,7 @@ void pairwise_distance(raft::resources const& handle,
  *
  * auto out = raft::make_device_matrix<double>(handle, x_nrows, y_nrows);
  * auto metric = cuvs::distance::DistanceType::L2Expanded;
- * raft::sparse::distance::pairwise_distance(handle, x.view(), y.view(), out, metric);
+ * cuvs::distance::pairwise_distance(handle, x.view(), y.view(), out, metric);
  * @endcode
  *
  * @param[in] handle raft::resources

cpp/include/cuvs/neighbors/cagra.hpp

@@ -484,7 +484,7 @@ struct index : cuvs::neighbors::index {
    *
    * - Cagra index is normally created by the cagra::build
    * @code{.cpp}
-   *   using namespace raft::neighbors::experimental;
+   *   using namespace cuvs::neighbors;
    *   auto dataset = raft::make_host_matrix<float, int64_t>(n_rows, n_cols);
    *   load_dataset(dataset.view());
    *   // use default index parameters
@@ -504,7 +504,7 @@ struct index : cuvs::neighbors::index {
    *
    * - Constructing index using existing knn-graph
    * @code{.cpp}
-   *   using namespace raft::neighbors::experimental;
+   *   using namespace cuvs::neighbors;
    *
    *   auto dataset = raft::make_device_matrix<float, int64_t>(res, n_rows, n_cols);
    *   auto knn_graph = raft::make_device_matrix<uint32_t, int64_t>(res, n_rows, graph_degree);
@@ -1166,7 +1166,7 @@ auto build(raft::resources const& res,
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto additional_dataset = raft::make_device_matrix<float, int64_t>(handle,add_size,dim);
  *   // set_additional_dataset(additional_dataset.view());
  *
@@ -1204,7 +1204,7 @@ void extend(
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto additional_dataset = raft::make_host_matrix<float, int64_t>(handle,add_size,dim);
  *   // set_additional_dataset(additional_dataset.view());
  *
@@ -1242,7 +1242,7 @@ void extend(
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto additional_dataset = raft::make_device_matrix<int8_t, int64_t>(handle,add_size,dim);
  *   // set_additional_dataset(additional_dataset.view());
  *
@@ -1280,7 +1280,7 @@ void extend(
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto additional_dataset = raft::make_host_matrix<int8_t, int64_t>(handle,add_size,dim);
  *   // set_additional_dataset(additional_dataset.view());
  *
@@ -1318,7 +1318,7 @@ void extend(
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto additional_dataset = raft::make_host_matrix<uint8_t, int64_t>(handle,add_size,dim);
  *   // set_additional_dataset(additional_dataset.view());
  *
@@ -1356,7 +1356,7 @@ void extend(
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto additional_dataset = raft::make_host_matrix<uint8_t, int64_t>(handle,add_size,dim);
  *   // set_additional_dataset(additional_dataset.view());
  *
@@ -2317,7 +2317,7 @@ void serialize_to_hnswlib(
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto dataset0 = raft::make_host_matrix<float, int64_t>(handle, size0, dim);
  *   auto dataset1 = raft::make_host_matrix<float, int64_t>(handle, size1, dim);
  *
@@ -2352,7 +2352,7 @@ auto merge(raft::resources const& res,
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto dataset0 = raft::make_host_matrix<half, int64_t>(handle, size0, dim);
  *   auto dataset1 = raft::make_host_matrix<half, int64_t>(handle, size1, dim);
  *
@@ -2387,7 +2387,7 @@ auto merge(raft::resources const& res,
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto dataset0 = raft::make_host_matrix<int8_t, int64_t>(handle, size0, dim);
  *   auto dataset1 = raft::make_host_matrix<int8_t, int64_t>(handle, size1, dim);
  *
@@ -2422,7 +2422,7 @@ auto merge(raft::resources const& res,
  *
  * Usage example:
  * @code{.cpp}
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   auto dataset0 = raft::make_host_matrix<uint8_t, int64_t>(handle, size0, dim);
  *   auto dataset1 = raft::make_host_matrix<uint8_t, int64_t>(handle, size1, dim);
  *

cpp/include/cuvs/neighbors/hnsw.hpp

@@ -185,7 +185,7 @@ struct extend_params {
  * Usage example:
  * @code{.cpp}
  *   // Build a CAGRA index
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   // use default index parameters
  *   cagra::index_params index_params;
  *   // create and fill the index from a [N, D] dataset
@@ -221,7 +221,7 @@ std::unique_ptr<index<float>> from_cagra(
  * Usage example:
  * @code{.cpp}
  *   // Build a CAGRA index
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   // use default index parameters
  *   cagra::index_params index_params;
  *   // create and fill the index from a [N, D] dataset
@@ -257,7 +257,7 @@ std::unique_ptr<index<half>> from_cagra(
  * Usage example:
  * @code{.cpp}
  *   // Build a CAGRA index
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   // use default index parameters
  *   cagra::index_params index_params;
  *   // create and fill the index from a [N, D] dataset
@@ -293,7 +293,7 @@ std::unique_ptr<index<uint8_t>> from_cagra(
  * Usage example:
  * @code{.cpp}
  *   // Build a CAGRA index
- *   using namespace raft::neighbors;
+ *   using namespace cuvs::neighbors;
  *   // use default index parameters
  *   cagra::index_params index_params;
  *   // create and fill the index from a [N, D] dataset

cpp/include/cuvs/neighbors/ivf_pq.hpp

@@ -2846,7 +2846,7 @@ void make_rotation_matrix(raft::resources const& res,
 
 /**
  * @brief Public helper API for externally modifying the index's IVF centroids.
- * NB: The index must be reset before this. Use raft::neighbors::ivf_pq::extend to construct IVF
+ * NB: The index must be reset before this. Use cuvs::neighbors::ivf_pq::extend to construct IVF
  lists according to new centroids.
  *
  * Usage example:

cpp/src/neighbors/ball_cover.cuh

@@ -130,7 +130,7 @@ void all_knn_query(raft::resources const& handle,
  *  #include <raft/core/resources.hpp>
  *  #include <cuvs/neighbors/ball_cover.hpp>
  *  #include <cuvs/distance/distance.hpp>
- *  using namespace raft::neighbors;
+ *  using namespace cuvs::neighbors;
  *
  *  raft::resources handle;
  *  ...

cpp/src/neighbors/ivf_flat/ivf_flat_build.cuh

@@ -162,7 +162,7 @@ RAFT_KERNEL build_index_kernel(const LabelT* labels,
   }
 }
 
-/** See raft::neighbors::ivf_flat::extend docs */
+/** See cuvs::neighbors::ivf_flat::extend docs */
 template <typename T, typename IdxT>
 void extend(raft::resources const& handle,
             index<T, IdxT>* index,
@@ -361,7 +361,7 @@ void extend(raft::resources const& handle,
   }
 }
 
-/** See raft::neighbors::ivf_flat::extend docs */
+/** See cuvs::neighbors::ivf_flat::extend docs */
 template <typename T, typename IdxT>
 auto extend(raft::resources const& handle,
             const index<T, IdxT>& orig_index,
@@ -374,7 +374,7 @@ auto extend(raft::resources const& handle,
   return ext_index;
 }
 
-/** See raft::neighbors::ivf_flat::build docs */
+/** See cuvs::neighbors::ivf_flat::build docs */
 template <typename T, typename IdxT>
 inline auto build(raft::resources const& handle,
                   const index_params& params,
@@ -435,7 +435,7 @@ inline auto build(raft::resources const& handle,
 /**
  * Build an index that can be used in refinement operation.
  *
- * See raft::neighbors::refine for details on the refinement operation.
+ * See cuvs::neighbors::refine for details on the refinement operation.
  *
  * The returned index cannot be used for a regular ivf_flat::search. The index misses information
  * about coarse clusters. Instead, the neighbor candidates are assumed to form clusters, one for

cpp/src/neighbors/ivf_flat/ivf_flat_search.cuh

@@ -10,7 +10,7 @@
 #include "../ivf_common.cuh"                  // cuvs::neighbors::detail::ivf
 #include "ivf_flat_interleaved_scan_ext.cuh"  // interleaved_scan
 #include <cuvs/neighbors/common.hpp>          // none_sample_filter
-#include <cuvs/neighbors/ivf_flat.hpp>        // raft::neighbors::ivf_flat::index
+#include <cuvs/neighbors/ivf_flat.hpp>        // cuvs::neighbors::ivf_flat::index
 
 #include "../detail/ann_utils.cuh"      // utils::mapping
 #include <cuvs/distance/distance.hpp>   // is_min_close, DistanceType
@@ -296,7 +296,7 @@ void search_impl(raft::resources const& handle,
                                      stream);
 }
 
-/** See raft::neighbors::ivf_flat::search docs */
+/** See cuvs::neighbors::ivf_flat::search docs */
 template <typename T,
           typename IdxT,
           typename IvfSampleFilterT = cuvs::neighbors::filtering::none_sample_filter>

cpp/src/neighbors/ivf_pq/ivf_pq_build.cuh

@@ -906,7 +906,7 @@ auto clone(const raft::resources& res, const index<IdxT>& source) -> index<IdxT>
 
 /**
  * Extend the index in-place.
- * See raft::spatial::knn::ivf_pq::extend docs.
+ * See cuvs::spatial::knn::ivf_pq::extend docs.
  */
 template <typename T, typename IdxT>
 void extend(raft::resources const& handle,
@@ -1108,7 +1108,7 @@ void extend(raft::resources const& handle,
 
 /**
  * Create a new index that contains more data.
- * See raft::spatial::knn::ivf_pq::extend docs.
+ * See cuvs::spatial::knn::ivf_pq::extend docs.
  */
 template <typename T, typename IdxT>
 auto extend(raft::resources const& handle,

cpp/src/neighbors/ivf_pq/ivf_pq_search.cuh

@@ -821,7 +821,7 @@ inline auto get_centers(const raft::resources& res, const index<IdxT>& index)
   if constexpr (std::is_same_v<T, int8_t>) { return index.centers_int8(res); }
 }
 
-/** See raft::spatial::knn::ivf_pq::search docs */
+/** See cuvs::spatial::knn::ivf_pq::search docs */
 template <typename T,
           typename IdxT,
           typename IvfSampleFilterT = cuvs::neighbors::filtering::none_sample_filter>