Skip to content

docs: align dense index lifecycle documentation - #2762

Merged
LHT129 merged 1 commit into
antgroup:mainfrom
LHT129:2026-08-25-修正稠密索引文档与实现不一致
Sep 1, 2026

Hidden character warning

The head ref may contain hidden characters: "2026-08-25-\u4fee\u6b63\u7a20\u5bc6\u7d22\u5f15\u6587\u6863\u4e0e\u5b9e\u73b0\u4e0d\u4e00\u81f4"
Merged

LHT129 merged 1 commit into
antgroup:mainfrom
LHT129:2026-08-25-修正稠密索引文档与实现不一致

Conversation

@LHT129

@LHT129 LHT129 commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Align dense-index lifecycle and input-type documentation with the current implementation.

Changes

  • Document BruteForce UpdateVector support and its FP32 input contract.
  • Document FP32 input boundaries for Pyramid, IVF, and BruteForce.
  • Correct lifecycle coverage for Pyramid and IVF MARK_REMOVE support.
  • Document BruteForce deletion restrictions with attribute filtering and multi-vector mode.

Validation

  • Ran git diff --check.
  • Checked the corrected capability statements and the Chinese/English document pairs.
  • No C++ code or tests changed.

Related

Copilot AI lite review requested due to automatic review settings August 25, 2026 08:05
@LHT129 LHT129 self-assigned this Aug 25, 2026
@pull-request-size pull-request-size Bot added the size/L 100-499 changed lines label Aug 25, 2026
@vsag-bot

vsag-bot commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

/label status/waiting-for-review
/waiting-on reviewer
/request-review @jiaweizone
/request-review @inabao

@mergify

mergify Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 2 merge protections satisfied — ready to merge.

Show 2 satisfied protections

🟢 Require kind label

  • label~=^kind/

🟢 Require version label

  • label~=^version/

@LHT129 LHT129 added kind/documentation Changes to docs, READMEs, or inline comments 文档、说明书、README 或注释的修改 version/1.2 labels Aug 25, 2026
@LHT129
LHT129 force-pushed the 2026-08-25-修正稠密索引文档与实现不一致 branch from f85ccf9 to 2192bb8 Compare August 25, 2026 08:07

Copilot AI 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.

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_REMOVE only; BruteForce supports UpdateVector and 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.

Copilot AI review requested due to automatic review settings August 25, 2026 08:09
Comment thread docs/docs/en/src/advanced/index_lifecycle.md

Copilot AI 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.

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Comment thread docs/docs/en/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/zh/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/en/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/zh/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/zh/src/advanced/index_lifecycle.md Outdated
Copilot AI review requested due to automatic review settings August 25, 2026 09:20
@LHT129
LHT129 force-pushed the 2026-08-25-修正稠密索引文档与实现不一致 branch from 2192bb8 to fdd1ea4 Compare August 25, 2026 09:20

Copilot AI 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.

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Comment thread docs/docs/en/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/zh/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/en/src/indexes/brute_force.md Outdated
Comment thread docs/docs/en/src/advanced/index_lifecycle.md
Comment thread docs/docs/en/src/advanced/index_lifecycle.md
Comment thread docs/docs/zh/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/en/src/indexes/brute_force.md Outdated
Comment thread docs/docs/zh/src/indexes/brute_force.md Outdated
Copilot AI review requested due to automatic review settings August 26, 2026 03:33
@LHT129
LHT129 force-pushed the 2026-08-25-修正稠密索引文档与实现不一致 branch from fdd1ea4 to cca2f3d Compare August 26, 2026 03:33

Copilot AI 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.

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Comment thread docs/docs/en/src/advanced/index_lifecycle.md Outdated
Comment thread docs/docs/zh/src/advanced/index_lifecycle.md Outdated

@LHT129 LHT129 left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

[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_REMOVE only; FORCE_REMOVE is not available.

Consider adding a similar note to the per-index deletion sections so readers consulting either page get the complete picture.

Signed-off-by: LHT129 <tianlan.lht@antgroup.com>
Assisted-by: Codex: GPT-5
Copilot AI review requested due to automatic review settings August 28, 2026 02:54
@LHT129
LHT129 force-pushed the 2026-08-25-修正稠密索引文档与实现不一致 branch from cca2f3d to 3f168fc Compare August 28, 2026 02:54

Copilot AI 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.

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Comment thread docs/docs/en/src/indexes/brute_force.md
Comment thread docs/docs/zh/src/indexes/brute_force.md
Comment thread docs/docs/en/src/indexes/brute_force.md
Comment thread docs/docs/zh/src/indexes/brute_force.md

@wxyucs wxyucs left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm

@mergify

mergify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@LHT129
LHT129 merged commit 5096a0a into antgroup:main Sep 1, 2026
19 checks passed
@wxyucs wxyucs added area/docs Website and repository documentation 网站与仓库文档 and removed module/docs labels Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Website and repository documentation 网站与仓库文档 kind/documentation Changes to docs, READMEs, or inline comments 文档、说明书、README 或注释的修改 size/L 100-499 changed lines version/1.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants