redis / redis/redis-vl-python

Add vector compression and SVS-VAMANA tuning guide to docs

Open
#500 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
427
Forks
101
Avg merge
6d 3h
Merged PRs (30d)
20

Description

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-build passes.

Out of Scope

  • Changing compression implementation behavior in code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing compression notebooks and API documentation, then add the focused guide at docs/user_guide/how_to_guides/vector_compression_tuning.md. Cover the requested tuning guidance and local benchmark workflow, link it from documentation navigation and related pages, and run make docs-build to verify completion.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, redis
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.