docs: align dense index lifecycle documentation - #2762
Hidden character warning
Conversation
|
/label status/waiting-for-review |
Merge Protections🟢 All 2 merge protections satisfied — ready to merge. Show 2 satisfied protections🟢 Require kind label
🟢 Require version label
|
f85ccf9 to
2192bb8
Compare
There was a problem hiding this comment.
Pull request overview
Updates the VSAG documentation to match current dense-index lifecycle behavior and FP32 input contracts, addressing the capability mismatches called out in #2761.
Changes:
- Clarifies that Pyramid/IVF/BruteForce public dense-vector paths accept FP32 input via
Dataset::Float32Vectors, and that internal quantizers do not expand accepted input types. - Corrects lifecycle/capability documentation: Pyramid and IVF support
RemoveMode::MARK_REMOVEonly; BruteForce supportsUpdateVectorand has documented deletion restrictions. - Aligns Chinese and English dense-index docs for the same capability statements and caveats.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs/zh/src/indexes/pyramid.md | Adds FP32-only input contract clarification for Pyramid. |
| docs/docs/zh/src/indexes/ivf.md | Adds FP32-only input contract clarification + notes IVF rejects dtype: "int8". |
| docs/docs/zh/src/indexes/brute_force.md | Documents FP32-only input, UpdateVector support, and deletion restrictions (attribute filter / multi-vector). |
| docs/docs/zh/src/advanced/index_lifecycle.md | Updates lifecycle/capability matrix and deletion/update semantics across indexes. |
| docs/docs/en/src/indexes/pyramid.md | Adds FP32-only input contract clarification for Pyramid. |
| docs/docs/en/src/indexes/ivf.md | Adds FP32-only input contract clarification + notes IVF rejects dtype: "int8". |
| docs/docs/en/src/indexes/brute_force.md | Documents FP32-only input, UpdateVector support, and deletion restrictions (attribute filter / multi-vector). |
| docs/docs/en/src/advanced/index_lifecycle.md | Updates lifecycle/capability matrix and deletion/update semantics across indexes. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
2192bb8 to
fdd1ea4
Compare
Signed-off-by: LHT129 <tianlan.lht@antgroup.com> Assisted-by: Codex: GPT-5
fdd1ea4 to
cca2f3d
Compare
| When `use_attribute_filter: true` is enabled, BruteForce supports neither removal mode; rebuild the index instead if attribute-filtered data must be deleted. | ||
|
|
||
| When operating in multi-vector mode, BruteForce supports `RemoveMode::MARK_REMOVE` only; `FORCE_REMOVE` is not available. |
| 启用 `use_attribute_filter: true` 时,BruteForce 不支持任一种删除模式;如需删除属性过滤数据,请重建索引。 | ||
|
|
||
| 在 multi-vector 模式下,BruteForce 仅支持 `RemoveMode::MARK_REMOVE`,不支持 `FORCE_REMOVE`。 | ||
|
|
LHT129
left a comment
There was a problem hiding this comment.
[suggestion] The per-index brute_force.md (both EN and ZH) deletion sections document the use_attribute_filter restriction but omit the multi-vector mode restriction that is correctly documented in index_lifecycle.md. The two pages should be consistent.
In docs/docs/en/src/indexes/brute_force.md line 131 and docs/docs/zh/src/indexes/brute_force.md line 124, only the use_attribute_filter restriction is noted. The index_lifecycle.md (both EN and ZH) correctly adds:
When operating in multi-vector mode, BruteForce supports
RemoveMode::MARK_REMOVEonly;FORCE_REMOVEis not available.
Consider adding a similar note to the per-index deletion sections so readers consulting either page get the complete picture.
Summary
Align dense-index lifecycle and input-type documentation with the current implementation.
Changes
UpdateVectorsupport and its FP32 input contract.MARK_REMOVEsupport.Validation
git diff --check.Related