Add vector compression and SVS-VAMANA tuning guide to docs
维护者通常 5 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 3-5 天
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python, redis
调研方向
检查现有的压缩 notebooks 和 API 文档，然后在 docs/user_guide/how_to_guides/vector_compression_tuning.md 中添加这份专门指南。涵盖所要求的调优指导和本地 benchmark 工作流，将其链接到文档导航和相关页面中，并运行 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
- 星标
- 433
- 派生
- 120
- 平均合并
- 7 天 18 小时
- 30 天内合并 PR
- 28
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
redis/redis-vl-python 的其他 Issue
-
SVS-VAMANA `compression` does not survive `IndexSchema.to_dict()`, breaking YAML round-trips and migration planning可能已有人在做 @Bhavy-Ranka 于 6 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
redis/redis-vl-python#808 · 2 条评论 ·
维护者通常 5 天内回复
-
RedisVL warnings are never shown when the application has not configured logging可能已有人在做 @hippi345 于 9 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 77/100
redis/redis-vl-python#786 ·
维护者通常 5 天内回复
-
exists() depends on exact FT.INFO error wording; an unrecognised "missing index" message makes create() never create the index (regression from #672)可能已有人在做 @Yarmoluk 于 2 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
redis/redis-vl-python#773 · 1 条评论 ·
维护者通常 5 天内回复
-
Vector field with index_missing=True cannot be created可能已有人在做 @RaphaelFakhri 于 19 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
redis/redis-vl-python#770 ·
维护者通常 5 天内回复
-
SearchIndex.drop_keys does not validate cluster hash-tag co-location (inconsistent with drop_documents)可能已有人在做 @Hashim1999164 于 18 天前认领。 未关闭bug good first issue index
难度 2/5 1-3 小时 新手友好度 78/100
redis/redis-vl-python#601 ·
维护者通常 5 天内回复
查看 redis/redis-vl-python 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 66/100
cline/mcp-marketplace#3576 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
griptape-ai/griptape-nodes-library-elevenlabs#30 ·
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 76/100
awslabs/social-messaging-agent-runtime-toolkit#140 ·
维护者通常 1 天内回复
-
subtask
难度 2/5 1-3 小时 新手友好度 72/100
fga-eps-mds/2026.2-MeasureSoftGram-DOC#187 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
NSPG13/agent-bounties#1747 ·
维护者通常 1 天内回复