Skip to content

[None][docs] Remove ghost --topr from RocketKV example command - #18952

Open
imitater-dou wants to merge 1 commit into
NVIDIA:mainfrom
imitater-dou:docs/fix-rocketkv-remove-ghost-topr
Open

[None][docs] Remove ghost --topr from RocketKV example command#18952
imitater-dou wants to merge 1 commit into
NVIDIA:mainfrom
imitater-dou:docs/fix-rocketkv-remove-ghost-topr

Conversation

@imitater-dou

@imitater-dou imitater-dou commented Sep 9, 2026

Copy link
Copy Markdown

Summary

  • Drop ghost --topr from the RocketKV llm_sparse_attention.py example command in examples/sparse_attention/RocketKV.md
  • CLI script has no --topr; API RocketSparseAttentionConfig.topr docs unchanged

Test plan

  • Confirmed examples/llm-api/llm_sparse_attention.py argparse has no --topr
  • Confirmed RocketSparseAttentionConfig still documents API topr
  • Docs render / markdown still valid

Dev Engineer Review

The RocketKV example command no longer passes the unsupported --topr 128 CLI option. The RocketSparseAttentionConfig.topr API documentation remains unchanged.

QA Engineer Review

No test changes.

Per-File QA Perspective

  • examples/sparse_attention/RocketKV.md: Verify the example command without --topr. Documentation rendering still needs follow-up.

The llm_sparse_attention.py CLI has no --topr flag; keep API topr docs.

Signed-off-by: ADou <ikun3.1415927@gmail.com>
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: b510fa2b-4b37-4a24-aa4d-449c54ef6a15

📥 Commits

Reviewing files that changed from the base of the PR and between 5601be6 and 9b44985.

📒 Files selected for processing (1)
  • examples/sparse_attention/RocketKV.md
💤 Files with no reviewable changes (1)
  • examples/sparse_attention/RocketKV.md

Included review availability: Your plan provides up to 12 included reviews per hour; 9 remain after this review.


Walkthrough

The RocketKV example command removes the --topr 128 option.

Changes

RocketKV example

Layer / File(s) Summary
Remove top-r option
examples/sparse_attention/RocketKV.md
The example command no longer passes --topr 128.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 9b449

The RocketKV example no longer shows an unsupported --topr option, aligning the documented command with the CLI. No merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format and clearly states that the unsupported --topr option was removed from the RocketKV documentation example.
Description check ✅ Passed The description explains the change, preserves the API documentation, and lists relevant verification steps. It does not include the full checklist or documentation-rendering result, but it provides s…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

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.

1 participant