Skip to content

Commit

Permalink
Fix serialize documentation of ivf_flat (#1347)
Browse files Browse the repository at this point in the history
I switched the doxygen documentation from `doxygenfunction` to `doxygengroup` because there was an issue resolving the `deserialize` methods on both ivf-flat and ivf-pq.

Authors:
  - Micka (https://github.com/lowener)

Approvers:
  - Corey J. Nolet (https://github.com/cjnolet)

URL: #1347
  • Loading branch information
lowener authored Mar 17, 2023
1 parent 7074010 commit 4577cbe
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
2 changes: 0 additions & 2 deletions cpp/include/raft/neighbors/ivf_flat_serialize.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ namespace raft::neighbors::ivf_flat {
* @param[in] os output stream
* @param[in] index IVF-Flat index
*
* @return raft::neighbors::ivf_flat::index<T, IdxT>
*/
template <typename T, typename IdxT>
void serialize(raft::device_resources const& handle, std::ostream& os, const index<T, IdxT>& index)
Expand Down Expand Up @@ -79,7 +78,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-Flat index
*
* @return raft::neighbors::ivf_flat::index<T, IdxT>
*/
template <typename T, typename IdxT>
void serialize(raft::device_resources const& handle,
Expand Down
8 changes: 8 additions & 0 deletions docs/source/cpp_api/neighbors_ivf_flat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,13 @@ namespace *raft::neighbors::ivf_flat*
:members:
:content-only:

Serializer Methods
------------------
``#include <raft/neighbors/ivf_flat_serialize.cuh>``

namespace *raft::neighbors::ivf_flat*

.. doxygengroup:: ivf_flat_serialize
:project: RAFT
:members:
:content-only:
13 changes: 4 additions & 9 deletions docs/source/cpp_api/neighbors_ivf_pq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,9 @@ Serializer Methods
------------------
``#include <raft/neighbors/ivf_pq_serialize.cuh>``

.. doxygenfunction:: serialize(raft::device_resources const& handle, std::ostream& os, const index<IdxT>& index)
:project: RAFT

.. doxygenfunction:: serialize(raft::device_resources const& handle, const std::string& filename, const index<IdxT>& index)
:project: RAFT
namespace *raft::neighbors::ivf_pq*

.. doxygenfunction:: deserialize(raft::device_resources const& handle, std::istream& is)
.. doxygengroup:: ivf_pq_serialize
:project: RAFT

.. doxygenfunction:: deserialize(raft::device_resources const& handle, const std::string& filename)
:project: RAFT
:members:
:content-only:

0 comments on commit 4577cbe

Please sign in to comment.