Skip to content

Fix comments in cpp/include/raft/neighbors/cagra_serialize.cuh #2283

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

Merged
rapids-bot merged 1 commit into from
May 1, 2024
Merged

Fix comments in cpp/include/raft/neighbors/cagra_serialize.cuh #2283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions cpp/include/raft/neighbors/cagra_serialize.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ namespace raft::neighbors::cagra {
*
* @code{.cpp}
* #include <raft/core/resources.hpp>
* #include <raft/neighbors/cagra_serialize.hpp>
* #include <raft/neighbors/cagra_serialize.cuh>
*
* raft::resources handle;
*
* // create an output stream
* std::ostream os(std::cout.rdbuf());
* // create an index with `auto index = raft::cagra::build(...);`
* raft::cagra::serialize(handle, os, index);
* // create an index with `auto index = raft::neighbors::cagra::build(...);`
* raft::neighbors::cagra::serialize(handle, os, index);
* @endcode
*
* @tparam T data element type
Expand Down Expand Up @@ -67,14 +67,14 @@ void serialize(raft::resources const& handle,
*
* @code{.cpp}
* #include <raft/core/resources.hpp>
* #include <raft/neighbors/cagra_serialize.hpp>
* #include <raft/neighbors/cagra_serialize.cuh>
*
* raft::resources handle;
*
* // create a string with a filepath
* std::string filename("/path/to/index");
* // create an index with `auto index = raft::cagra::build(...);`
* raft::cagra::serialize(handle, filename, index);
* // create an index with `auto index = raft::neighbors::cagra::build(...);`
* raft::neighbors::cagra::serialize(handle, filename, index);
* @endcode
*
* @tparam T data element type
Expand Down Expand Up @@ -102,14 +102,14 @@ void serialize(raft::resources const& handle,
*
* @code{.cpp}
* #include <raft/core/resources.hpp>
* #include <raft/neighbors/cagra_serialize.hpp>
* #include <raft/neighbors/cagra_serialize.cuh>
*
* raft::resources handle;
*
* // create an output stream
* std::ostream os(std::cout.rdbuf());
* // create an index with `auto index = raft::cagra::build(...);`
* raft::cagra::serialize_to_hnswlib(handle, os, index);
* // create an index with `auto index = raft::neighbors::cagra::build(...);`
* raft::neighbors::cagra::serialize_to_hnswlib(handle, os, index);
* @endcode
*
* @tparam T data element type
Expand All @@ -135,14 +135,14 @@ void serialize_to_hnswlib(raft::resources const& handle,
*
* @code{.cpp}
* #include <raft/core/resources.hpp>
* #include <raft/neighbors/cagra_serialize.hpp>
* #include <raft/neighbors/cagra_serialize.cuh>
*
* raft::resources handle;
*
* // create a string with a filepath
* std::string filename("/path/to/index");
* // create an index with `auto index = raft::cagra::build(...);`
* raft::cagra::serialize_to_hnswlib(handle, filename, index);
* // create an index with `auto index = raft::neighbors::cagra::build(...);`
* raft::neighbors::cagra::serialize_to_hnswlib(handle, filename, index);
* @endcode
*
* @tparam T data element type
Expand All @@ -168,15 +168,15 @@ void serialize_to_hnswlib(raft::resources const& handle,
*
* @code{.cpp}
* #include <raft/core/resources.hpp>
* #include <raft/neighbors/cagra_serialize.hpp>
* #include <raft/neighbors/cagra_serialize.cuh>
*
* raft::resources handle;
*
* // create an input stream
* std::istream is(std::cin.rdbuf());
* using T = float; // data element type
* using IdxT = int; // type of the index
* auto index = raft::cagra::deserialize<T, IdxT>(handle, is);
* auto index = raft::neighbors::cagra::deserialize<T, IdxT>(handle, is);
* @endcode
*
* @tparam T data element type
Expand All @@ -200,15 +200,15 @@ index<T, IdxT> deserialize(raft::resources const& handle, std::istream& is)
*
* @code{.cpp}
* #include <raft/core/resources.hpp>
* #include <raft/neighbors/cagra_serialize.hpp>
* #include <raft/neighbors/cagra_serialize.cuh>
*
* raft::resources handle;
*
* // create a string with a filepath
* std::string filename("/path/to/index");
* using T = float; // data element type
* using IdxT = int; // type of the index
* auto index = raft::cagra::deserialize<T, IdxT>(handle, filename);
* auto index = raft::neighbors::cagra::deserialize<T, IdxT>(handle, filename);
* @endcode
*
* @tparam T data element type
Expand Down