Improve filtering documentation#568
Conversation
| Using filters in cuVS | ||
| ===================== | ||
|
|
||
| Example |
There was a problem hiding this comment.
Rust doc makes different sized heading for each different type of heading symbol used. Please follow other docs and use different symbols for these. based on the order it traverses the heading tree, it'll figure out which ones whould be H1, H2, H3, and so on, so long as you are consistent about where they are used.
|
|
||
| .. code-block:: c++ | ||
|
|
||
| #include <cuvs/neighbors/cagra.hpp> |
There was a problem hiding this comment.
Can you add an example cu file in examples/cpp as well (assuming it doesn't exist already). That would also be a great thing to link to from these docs.
|
|
||
| CuVS supports different type of filtering depending on the vector index being used. The main method used in all of the vector indexes | ||
| is pre-filtering, which is a technique that will into account the filtering of the vectors before computing it's closest neighbors, saving | ||
| some computation from calculating distances. |
There was a problem hiding this comment.
Given that this is a supposed to be included in the getting started guide, I think we should provide a little more info to beginner users who might not be familiar with the "when" and "why". Adding some use-cases here could be helpful for users.
| ---------------- | ||
|
|
||
| Each cluster is padded to at least 32 vectors (but potentially up to 1024). Assuming uniform random distribution of vectors/list, we would have | ||
| :math:`cluster\_overhead = (conservative\_memory\_allocation ? 16 : 512 ) * dim * sizeof_{float})` |
There was a problem hiding this comment.
This was intentional here- we want the float to be a subscript for ease of readership (it aligns better swith the reast of the formulas since we are using latex all over the place already).
Co-authored-by: Corey J. Nolet <cjnolet@gmail.com>
cjnolet
added
improvement
|
/merge |
2 participants
This PR add a dedicated documentation page for filtering in the
Getting startedtab, and add thecuvs::neighbors::filteringnamespace to the C++ documentation