Add vector compression and SVS-VAMANA tuning guide to docs
メンテナーはふだん 5 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python, redis
調査の方向性
既存の圧縮ノートブックと API ドキュメントを確認し、docs/user_guide/how_to_guides/vector_compression_tuning.md に対象を絞ったガイドを追加してください。要求されているチューニングの指針とローカルベンチマークのワークフローを扱い、ドキュメントのナビゲーションと関連ページからリンクし、make docs-build を実行して完了を確認してください。
索引モデルが issue の本文から書いたものです。
説明
Summary
Create a focused documentation guide for vector compression and SVS-VAMANA tuning in RedisVL.
Level: Intermediate
Current State
- Compression concepts are present but spread across notebooks and API docs.
- There is no single practical guide for when/how to use compression options and how to evaluate tradeoffs.
Proposed Change
- Add a docs guide (for example
docs/user_guide/how_to_guides/vector_compression_tuning.md) that covers:- when compression is appropriate
- choosing algorithm and key params
- expected memory/latency/recall tradeoffs
- safe rollout/testing checklist
- links to relevant API docs and notebooks
- Include a minimal reproducible benchmark workflow users can run locally.
Definition of Done
- New guide is linked from docs navigation and related pages.
- Includes actionable tuning recommendations and validation checklist.
make docs-buildpasses.
Out of Scope
- Changing compression implementation behavior in code.
- 主要言語
- Python
- スター
- 431
- フォーク
- 107
- 平均マージ
- 5日 17時間
- マージ済み PR（30日）
- 16
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
redis/redis-vl-python のほかの issue
-
exists() depends on exact FT.INFO error wording; an unrecognised "missing index" message makes create() never create the index (regression from #672)対応中かも @sarankumar1325 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
redis/redis-vl-python#773 ·
メンテナーはふだん 5 日以内に返信
-
Vector field with index_missing=True cannot be created対応中かも @RaphaelFakhri が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
redis/redis-vl-python#770 ·
メンテナーはふだん 5 日以内に返信
-
Add Python 3.15 support対応中かも @vishal-bala が 4 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
redis/redis-vl-python#757 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 5 日以内に返信
-
SearchIndex.drop_keys does not validate cluster hash-tag co-location (inconsistent with drop_documents)対応中かも @Hashim1999164 が 1 日前に担当しました。 オープンbug good first issue index
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
redis/redis-vl-python#601 ·
メンテナーはふだん 5 日以内に返信
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
redis/redis-vl-python#300 ·
メンテナーはふだん 5 日以内に返信
redis/redis-vl-python の issue をすべて見る
似ている issue
-
wr.dynamodb.read_items returns [{}] for a single partition value that does not exist対応中かも @auraseb が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
aws/aws-sdk-pandas#3520 ·
メンテナーはふだん 2 日以内に返信
-
requires triage typing
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
sqlalchemy/sqlalchemy#13704 ·
メンテナーはふだん 1 日以内に返信
-
Edit tool converts CRLF files to LF対応中かも @RaphaelFakhri が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
huggingface/tau#774 ·
メンテナーはふだん 1 日以内に返信
-
show ignores the row limit when a column or table name contains "limit"対応中かも @RaphaelFakhri が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
linebender/resvg#1179 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信