facebookresearch / facebookresearch/faiss
incorrect reference for using GPU without index
- Dominant language
- C++
- Stars
- 40.9k
- Forks
- 4.5k
- PR merge metrics
- No merged PRs in 30d
Description
in this tutorial page: https://github.com/facebookresearch/faiss/wiki/Brute-force-search-without-an-index
there are a few incorrect references:
- it says "for numpy data, use `contrib.exhaustive_search.knn_gpu`, tested in gpu/test_contrib.py": that code doesn't have `knn_gpu` and `knn_gpu` is not in `contrib.exhaustive_search`; an example about `knn_gpu` is here https://github.com/facebookresearch/faiss/blob/main/faiss/gpu/test/torch_test_contrib_gpu.py
- it says "An example usage in python, from pytorch GPU data is here: test_pytorch_faiss.py", but there is no such page found.
Contributor guide
Research direction
Open the Brute-force search without an index tutorial and check each cited API and example against faiss/gpu/test/torch_test_contrib_gpu.py and the repository search. Replace the incorrect or missing references with existing targets, then verify that every linked example and API name resolves and matches the surrounding text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python, pytorch
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100