-
Notifications
You must be signed in to change notification settings - Fork 985
[docs] conductor docs #2970
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
[docs] conductor docs #2970
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
343 changes: 191 additions & 152 deletions
343
docs/source/design/conductor/conductor-architecture-design.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Mooncake Conductor | ||
|
|
||
| [中文](../../zh/design/conductor/index.md) | ||
|
|
||
| Mooncake Conductor keeps an in-memory view of reusable key-value (KV) cache | ||
| blocks reported by inference engines and Mooncake Store. A router can query | ||
| that view before choosing an inference engine. Use this page to find the guide | ||
| for running Conductor, understanding its results, or integrating a client. | ||
|
|
||
| ## Choose a task | ||
|
|
||
| ### Run Conductor | ||
|
|
||
| Follow the [usage guide](./usage.md) to build the C++ service, configure event | ||
| sources, check registrations, query cache availability, and unregister a | ||
| source. | ||
|
|
||
| ### Understand the result | ||
|
|
||
| Read the [architecture guide](./conductor-architecture-design.md) to see how | ||
| vLLM GPU events and shared Mooncake CPU or Disk events become per-engine query | ||
| results. | ||
|
|
||
| ### Call the HTTP API | ||
|
|
||
| Use the [HTTP API reference](./indexer-api-design.md) for the five implemented | ||
| endpoints, their accepted fields, response bodies, and error formats. | ||
|
|
||
| ### Connect event sources | ||
|
|
||
| Start with [KV Events](../kv-event/index.md) to compare the vLLM and Mooncake | ||
| message paths. That section also explains what Mooncake publishes and what | ||
| Conductor accepts. | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 1 | ||
| :hidden: | ||
|
|
||
| conductor-architecture-design | ||
| usage | ||
| ``` | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The English
toctreelist is missing theindexer-api-designreference, which is present in the Chinese version. This causes the HTTP API reference page to be omitted from the Conductor section navigation in English.