Docs: add runtime logic, orchestration guides, and roadmap

[ChaoWao]

Summary

Add comprehensive documentation for all three runtimes:

• INCORE_ORCHESTRATION_GUIDE for each runtime (host_build_graph, aicpu_build_graph, tensormap_and_ringbuffer)
• RUNTIME_LOGIC explaining execution flow and component interactions
• ROADMAP for tensormap_and_ringbuffer advanced scheduling features

All documentation placed in src/a2a3/runtime/ to align with PR #182's architecture-specific directory layout.

Testing

• Documentation only - no tests required

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by providing comprehensive guides for various runtime orchestration mechanisms. It clarifies the architecture, data structures, and operational flows for different graph building strategies, enabling developers to better understand and implement custom orchestration logic.

Highlights

• Runtime Logic Documentation: New documentation files were added detailing the runtime logic for host_build_graph, aicpu_build_graph, and tensormap_and_ringbuffer runtimes, covering their overview, core data structures, and execution flows.
• InCore Orchestration Guides: Dedicated InCore orchestration guides were introduced for host_build_graph and tensormap_and_ringbuffer examples, explaining how to structure orchestration code, function signatures, argument layouts, and graph building processes.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• examples/host_build_graph/docs/INCORE_ORCHESTRATION_GUIDE.md
  • Added a new guide for InCore orchestration specific to host_build_graph.
• examples/tensormap_and_ringbuffer/docs/INCORE_ORCHESTRATION_GUIDE.md
  • Added a new guide for InCore orchestration specific to tensormap_and_ringbuffer.
• src/runtime/aicpu_build_graph/docs/RUNTIME_LOGIC.md
  • Added new documentation detailing the runtime logic for aicpu_build_graph.
• src/runtime/host_build_graph/docs/RUNTIME_LOGIC.md
  • Added new documentation detailing the runtime logic for host_build_graph.
• src/runtime/tensormap_and_ringbuffer/docs/RUNTIME_LOGIC.md
  • Added new documentation detailing the runtime logic for tensormap_and_ringbuffer.

Activity

• The pull request author, ChaoWao, has indicated that testing was not run as the changes are documentation-only.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces extensive documentation for the runtime and orchestration logic. The new guides for host_build_graph, aicpu_build_graph, and tensormap_and_ringbuffer are well-written, providing clear explanations of their architecture, data flows, and key components. This will be very helpful for developers working with these runtimes. I have one minor suggestion to improve clarity in one of the documents.

[ChaoWao]

Missing aicpu_build_graph INCORE_ORCHESTRATION_GUIDE.

[ChaoWao]

Added missing aicpu_build_graph INCORE_ORCHESTRATION_GUIDE.md in src/runtime/aicpu_build_graph/docs/. Please re-review. (commit e15940e)

[gemini-code-assist]

Thank you for the detailed status update, @ChaoWao! I appreciate you addressing all the review comments, including the suggestion regarding "tensor argument order" in the host_build_graph guide and correctly placing the aicpu_build_graph INCORE_ORCHESTRATION_GUIDE.md.

The pull request looks good to merge. Great work on enhancing the documentation!

[ChaoWao]

You shall rebase origin/main and try update the doc according to newest code status.