[DOC] Document exactly which filter types are compatible with which algorithms
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
I just noticed the CAGRA search functions don't really tell the user what filtering functions it accepts. We should do a better job of communicating this in the docs by listing out each and every specific filtering implementation each search function that each index supports.
I was digging through the CAGRA APIs to verify that we haven't yet added support for the bitmap filter and it was harder than it should have been to find this out, especially when it could have just been added to the dos.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the CAGRA search APIs and the filtering implementations they currently accept. Trace each search function and supported index to verify filter compatibility, including whether bitmap filtering is supported. Update the documentation with a complete compatibility list, then confirm every documented combination matches the APIs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100