[DOC] CAGRA documentation fix for load
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start at the CAGRA Python API documentation for cagra.load linked in the issue and compare its documented call with the working Index, Dataset, and out_dataset example. Update the definition and example to match the current API, then verify that the documented load call runs without the reported TypeError and returns neighbors and distances.
Written by the indexing model from the issue text.
Description
Report incorrect documentation
Location of incorrect documentation
https://docs.nvidia.com/cuvs/api-reference/python-api-neighbors-cagra#load
Describe the problems or issues found in the documentation
This is inconsistent with the current version.
Steps taken to verify documentation is incorrect
simply doing whatever is written in the index is throwing error.
File "x/x1.py", line 53, in main index = cagra.load("index") ^^^^^^^^^^^^^^^^^^^ File "cuvs/common/resources.pyx", line 128, in cuvs.common.resources.auto_sync_resources.wrapper File "cuvs/neighbors/cagra/cagra.pyx", line 980, in cuvs.neighbors.cagra.cagra.load TypeError: load() takes at least 2 positional arguments (1 given
Suggested fix for documentation
please change the definition of the one in the documentation
Report needed documentation
Report needed documentation
this is the actual way to load it I believe, this works properly and returns the distances & neighbors.
index = cagra.Index()
dataset = cagra.Dataset()
cagra.load(
index,
"index",
out_dataset=dataset,
)
cuvs version: 26.08.01
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 65
Getting set up
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.
More from NVIDIA/cuvs
-
faiss improvement
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
Similar issues
-
docs pydanty:is-working
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
pydantic/pydantic-ai#8863 ·
Maintainers usually reply within 1 day
-
documentation from-review-extraction github-actions priority: low severity:nit
Difficulty 1/5 Under an hour Newbie friendliness 92/100
LearningCircuit/local-deep-research#6946 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 88/100
esphome/device-builder#2856 ·
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
mantinedev/mantine#9223 ·
Maintainers usually reply within 6 days