docs(compute-mesh): add architecture diagram and execution flow documentation for local_compute_mesh_demo#1087
Closed
Avi-47 wants to merge 1 commit intomofa-org:mainfrom
Closed
Conversation
…entation for local_compute_mesh_demo
6 tasks
Contributor
Author
|
The documentation from this PR has been incorporated into a consolidated compute mesh demo PR #1248 that includes:
Combining them into one PR keeps the demo easier to review and shows the complete compute mesh pipeline in a single example. Closing this PR in favor of the consolidated version. Thanks! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Added comprehensive architecture diagrams and execution flow documentation to the local_compute_mesh_demo. This documentation provides visual and textual explanations of how the compute mesh pipeline works, making it easier for developers to understand and use the demo.
Motivation
Issue #1085 requested adding interactive architecture diagrams and execution visualization documentation for the local_compute_mesh_demo. Without proper documentation, users may struggle to understand:
This PR addresses these gaps by providing clear, visual documentation.
Changes Made
1. Compute Mesh Architecture Diagram
Created a detailed ASCII diagram showing the complete pipeline:
2. Execution Lifecycle Explanation
Documented all 7 stages with a comprehensive table:
workflow.startrouter.policyrouter.backend_selectioninference.startstreaming.tokensmetrics.latency_msworkflow.completeEach stage includes details on what component runs, what it does, and what log appears in the demo.
3. Routing Policy Explanation
Explained three routing policies:
LocalFirstWithCloudFallback: Attempts local inference first, falls back to cloud if local fails. Use case: Balance of speed and reliability.
LocalOnly: Uses only local inference backend. Use case: Offline mode, privacy-sensitive applications.
CloudOnly: Uses only cloud inference backend. Use case: Maximum model capacity, always-online scenarios.
Also included a backend selection logic flow diagram.
4. Execution Walkthrough
Added a step-by-step example using real logs from the demo, showing:
5. ASCII Pipeline Visualization
Added a comprehensive visual representation of the entire pipeline.
Testing
Additional Notes
References
local_compute_mesh_demo#1085