[DOC] CAGRA documentation fix for load
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- python
調査の方向性
issue にリンクされている CAGRA Python API ドキュメントの cagra.load から始め、そこに記載された呼び出しを、Index、Dataset、out_dataset を使った動作する例と比較してください。定義と例を現在の API に一致するように更新し、その後、ドキュメントに記載された load の呼び出しが報告された TypeError なしで実行され、近傍と距離を返すことを確認してください。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- Cuda
- スター
- 859
- フォーク
- 239
- 平均マージ
- 2日 19時間
- マージ済み PR（30日）
- 62
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NVIDIA/cuvs のほかの issue
-
faiss improvement
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
documentation
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
bug docs
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信