Fixing broken doc functions and improving coverage #1030
Conversation
cjnolet
added
improvement
|
rerun tests |
1 similar comment
|
rerun tests |
| namespace raft::random { | ||
|
|
||
| /** | ||
| * @brief Matrix decomposition method for `compute_multi_variable_gaussian` to use. |
There was a problem hiding this comment.
Is this docstring supposed to appear in the API docs? I do not see it there.
| ------------------- | ||
| ################### | ||
|
|
||
| Header: `raft/spectral/partition.cuh` |
There was a problem hiding this comment.
For some reason, the function signatures in the Spectral clustering group are rendered differently than other functions (all highlighted with bold mangenta colored text). Note that is not caused by this PR, it was like that previously.
| :project: RAFT | ||
|
|
||
|
|
||
|
|
||
|
|
||
| mdarray | ||
| ####### |
| @@ -136,42 +153,15 @@ mdspan | |||
| .. doxygentypedef:: raft::mdspan | |||
|
|
||
|
|
||
| IVF-Flat | ||
| -------- | ||
|
|
||
| Header: `raft/neighbors/ivf_flat.cuh` |
There was a problem hiding this comment.
- The docstring of index_params and search params refers to headers as
#include <ivf_flat_types.hpp>. We should have the full path, and preferably the same visual highlighting as for other headers. - The index_params / search params arguments of build/search is not hyperlinked to the type definition.
|
|
||
|
|
||
| IVF-PQ | ||
| -------- | ||
|
|
||
| Header: `raft/neighbors/ivf_pq.cuh` |
There was a problem hiding this comment.
Same as above, the header file for index and search params shall contain full path. It would be good to list these structs before the
| @@ -2,8 +2,6 @@ | |||
| C++ API Reference | |||
| ~~~~~~~~~~~~~~~~~ | |||
|
|
|||
|
|
|||
|
|
|||
There was a problem hiding this comment.
Shall the section heads below be in alphabetical order?
|
|
||
| Brute-force | ||
| ----------- | ||
|
|
||
| Header: `raft/neighbors/brute_force.cuh` |
There was a problem hiding this comment.
What about adding a cross reference to sparse/neighbors/brute_force_knn?
|
@tfeher thank you for the detailed review (and for doing it on such short notice)! Since code freeze is tomorrow (which is a US holiday), I’m definitely going to create a follow-on PR for all of these items, but I’ll target it for 23.02. |
|
@gpucibot merge |
No description provided.