Skip to content

[Doc] Reorganize performance docs#2824

Merged
alogfans merged 6 commits into
kvcache-ai:mainfrom
ykwd:docs/update-performance
Jul 10, 2026
Merged

[Doc] Reorganize performance docs#2824
alogfans merged 6 commits into
kvcache-ai:mainfrom
ykwd:docs/update-performance

Conversation

@ykwd

@ykwd ykwd commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Description

  • Reorganize performance documentation into performance/mooncake/, performance/sglang/, and performance/vllm/ subdirectories for clearer navigation.
  • Rename and retitle key benchmark pages for consistency (e.g. vLLM PD disaggregation, vLLM × Mooncake Store, SGLang HiCache × Mooncake Store).
  • Remove legacy vLLM V0/V1 preview benchmark pages (vllm-benchmark-results-v0.2.md, vllm-benchmark-results-v1.md) and update cross-references across design, deployment, and integration guides.

Module

  • Transfer Engine (mooncake-transfer-engine)
  • Mooncake Store (mooncake-store)
  • Mooncake EP (mooncake-ep)
  • Mooncake PG (mooncake-pg)
  • Integration (mooncake-integration)
  • P2P Store (mooncake-p2p-store)
  • Python Wheel (mooncake-wheel)
  • Common (mooncake-common)
  • Mooncake RL (mooncake-rl)
  • CI/CD
  • Docs
  • Other

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Breaking change
  • Documentation update
  • Performance improvement
  • Other

How Has This Been Tested?

Test commands:

# Example: bash scripts/run_ci_test.sh

Test results:

  • Unit tests pass
  • Integration tests pass (if applicable)
  • Manual testing done (describe below)

Checklist

  • I have performed a self-review of my own code
  • I have formatted my code using ./scripts/code_format.sh
  • I have run pre-commit run --all-files and all hooks pass
  • I have updated the documentation (if applicable)
  • I have added tests to prove my changes are effective
  • For changes >500 LOC: I have filed an RFC issue

AI Assistance Disclosure

  • No AI tools were used
  • AI tools were used (specify below)

@github-actions github-actions Bot added documentation Improvements or additions to documentation run-ci labels Jul 9, 2026

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request reorganizes the documentation by moving benchmark results into dedicated subdirectories under 'performance' (mooncake, sglang, and vllm) and updating all internal links accordingly. It also removes some legacy benchmark files and cleans up trailing whitespaces. The feedback suggests a minor grammatical correction to capitalize 'if' at the beginning of a sentence in the HiCache integration guide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

When a `PutStart` request fails due to insufficient memory, or when the eviction thread detects that space usage has reached the configured high watermark ratio, an eviction task is triggered to free up space by evicting a portion of objects.

Due to memory fragmentation, allocation failures may occur even when memory usage has not yet reached 100%. The actual threshold depends on the workload. This [benchmark document](https://kvcache-ai.github.io/Mooncake/performance/allocator-benchmark-result.html) provides memory allocation efficiency results under different scenarios. if excessive allocation failures are observed, consider lowering this parameter accordingly.
Due to memory fragmentation, allocation failures may occur even when memory usage has not yet reached 100%. The actual threshold depends on the workload. This [benchmark document](https://kvcache-ai.github.io/Mooncake/performance/mooncake/allocator-benchmark-result.html) provides memory allocation efficiency results under different scenarios. if excessive allocation failures are observed, consider lowering this parameter accordingly.

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.

medium

Capitalize 'if' to 'If' at the beginning of the sentence to maintain proper grammar and style consistency.

Suggested change
Due to memory fragmentation, allocation failures may occur even when memory usage has not yet reached 100%. The actual threshold depends on the workload. This [benchmark document](https://kvcache-ai.github.io/Mooncake/performance/mooncake/allocator-benchmark-result.html) provides memory allocation efficiency results under different scenarios. if excessive allocation failures are observed, consider lowering this parameter accordingly.
Due to memory fragmentation, allocation failures may occur even when memory usage has not yet reached 100%. The actual threshold depends on the workload. This [benchmark document](https://kvcache-ai.github.io/Mooncake/performance/mooncake/allocator-benchmark-result.html) provides memory allocation efficiency results under different scenarios. If excessive allocation failures are observed, consider lowering this parameter accordingly.

@alogfans
alogfans merged commit 3d0748c into kvcache-ai:main Jul 10, 2026
16 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation run-ci

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants