docs: progressive learning structure with per-executor guides and architecture reference#467
Open
docs: progressive learning structure with per-executor guides and architecture reference#467
Conversation
…hitecture reference Restructures the guides into a layered learning path so users get something working first and deepen understanding step by step: - Add quickstart.md: 5-minute local run using run.Script + LocalExecutor - Add executors/ directory with per-executor guides (local, docker, slurm, skypilot, dgxcloud, lepton, kuberay), each with prerequisites, annotated config, and an end-to-end workflow - Add architecture.md: Experiment call chain, Executor→TorchX scheduler mapping, metadata layout, and contributor steps for adding a new executor - Update execution.md: remove per-executor sections (now in executors/); add links to executors/ and architecture.md - Update management.md: add "Putting it all together" e2e section - Update ray.md: add "When to use Ray" decision table, per-backend prerequisites, and cross-links to executor guides before each quick-start - Update index.md: reorder toctree to match the learning path Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: oliver könig <okoenig@nvidia.com>
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
quickstart.md— a 5-minute working example usingrun.Script+LocalExecutor, no cluster or SSH requiredexecutors/directory with seven per-executor guides (local,docker,slurm,skypilot,dgxcloud,lepton,kuberay), each following a consistent structure: prerequisites → annotated config → e2e workflow → advanced optionsarchitecture.md— internals reference covering theExperimentcall chain, Executor→TorchX scheduler mapping, metadata storage layout, and contributor steps for adding a new executorexecution.md— removes the per-executor sections (now inexecutors/); keeps packager/launcher reference; adds links toexecutors/andarchitecture.mdmanagement.md— adds a "Putting it all together" e2e section at the end that ties config + remote executor +Experiment.from_idtogetherray.md— adds a "When to use Ray vs. standard execution" decision table, per-backend prerequisites, and cross-links to the relevant executor guide before each quick-start section; marksCustomJobDetailsas an advanced patternindex.mdtoctree to match the progressive learning path: quickstart → configuration → execution → executors/ → management → cli → ray → architectureGuide ordering rationale
Each level deliberately avoids introducing concepts from the next:
quickstart—LocalExecutoronly, no packager/SSHexecutors/— ordered by setup cost (local → docker → slurm → skypilot → dgxcloud → lepton → kuberay)management"putting it all together" references a remote executor so it lands afterexecutors/architectureis last — internals make sense only once the user-facing model is understoodTest plan
sphinx-build docs/ _build/html— all toctree references resolve with no warningsexecutors/,ray.md, andarchitecture.mdare consistent🤖 Generated with Claude Code