Skip to content

docs: add product quantization guides for HNSW and IVF - #85

Open
richyreachy wants to merge 4 commits into
zvec-ai:mainfrom
richyreachy:docs/turbo-pq
Open

richyreachy wants to merge 4 commits into
zvec-ai:mainfrom
richyreachy:docs/turbo-pq

Conversation

@richyreachy

Copy link
Copy Markdown
Contributor

Document the product quantization support introduced in alibaba/zvec#833 for the 0.8.1 release.

  • Add English and Chinese guides covering PQ4/PQ8, OPQ, IVF FastScan, parameter constraints, training during Collection.optimize(), and query refinement.
  • Include Python examples for HNSW-PQ and IVF-PQ, and link the guides from navigation and existing index documentation.
  • Correct quantization configuration examples to place parameters in the index configuration.
  • Use a plain GitHub link during development so API rate limits do not block documentation previews.

@richyreachy
richyreachy requested a review from iaojnh November 9, 2026 05:00
@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

☁️ Cloudflare Pages preview: https://74e23c27.zvec-web.pages.dev

@iaojnh iaojnh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image PQ作为量化的子文档吧

@zhourrr

zhourrr commented Nov 12, 2026

Copy link
Copy Markdown
Collaborator

建议先同步最新 main,移除本 PR 对 app/[lang]/docs/layout.tsx 的改动,仅保留 PQ 文档相关变更。

GitHub 统计请求的容错已经随 #84 合入主线(df1e306):文档布局改用项目自己的 GithubInfo,请求默认有 3 秒超时,限流、网络异常和无效响应都会降级为只显示仓库链接,不再导致文档页面报错。这套处理同时覆盖本地开发和生产构建,详见 lib/github-info.ts。

因此,本 PR 新增的 RepositoryInfo development 分支,对于“避免 GitHub API 失败阻塞文档预览”已经不是必需的。它剩余的额外收益是开发时完全跳过请求、避免等待,但也会让开发与生产侧栏的显示不同,与 PQ 文档本身无关,建议直接移除。

另外检查了 GitHub 当前生成的合并结果,会保留主线的容错组件,不存在正常合并后覆盖 #84 修复的问题;这里主要是清理重复处理、收敛 PR 范围。

文档部分未发现阻塞性问题:将 PQ 作为量化的子文档是合理的,原量化页 URL 保持不变,新增相对链接以及量化参数配置位置的修正也正确。

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants