Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s CLI documentation and example workers to use the new Endpoint API (replacing @remote + LiveServerless/LB resource configs), aligning the examples with the upstream flash migration referenced in the PR description.
Changes:
- Migrates docs and examples from
@remote(...)+LiveServerless/LB configs to@Endpoint(...)andEndpoint(...).get()/.post()route decorators. - Updates autoscaling/resource configuration examples to the new parameter names (e.g.,
workers=(min, max),idle_timeout,scaler_type,scaler_value). - Refreshes repository-level docs (README/CONTRIBUTING/CLI reference) to describe the new endpoint patterns (QB vs LB).
Reviewed changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/cli/workflows.md | Updates workflow snippets and output examples to Endpoint terminology/config. |
| docs/cli/troubleshooting.md | Migrates troubleshooting snippets to @Endpoint(...). |
| docs/cli/getting-started.md | Updates getting-started code sample to @Endpoint(...) (but introduces GpuType reference). |
| docs/cli/commands.md | Updates CLI command docs to refer to @Endpoint discovery and Endpoint types. |
| README.md | Updates discovery/architecture documentation and adds QB/LB/client-mode Endpoint examples. |
| DEVELOPMENT.md | Updates new-example guidance to reference @Endpoint discovery and dependency declaration. |
| CONTRIBUTING.md | Updates contribution checklist and examples to use Endpoint patterns. |
| CLI-REFERENCE.md | Updates CLI reference to @Endpoint discovery and build handler generation. |
| CLAUDE.md | Updates repo architecture summary and patterns to Endpoint QB/LB conventions. |
| 05_data_workflows/01_network_volumes/gpu_worker.py | Converts class-based GPU worker to @Endpoint(...) with volume/env/deps. |
| 05_data_workflows/01_network_volumes/cpu_worker.py | Converts CPU LB worker to Endpoint(...).get() routes with shared volume. |
| 05_data_workflows/01_network_volumes/README.md | Updates example README terminology from @remote to @Endpoint. |
| 04_scaling_performance/01_autoscaling/gpu_worker.py | Converts autoscaling GPU strategies to @Endpoint(...) with scaler params. |
| 04_scaling_performance/01_autoscaling/cpu_worker.py | Converts autoscaling CPU strategies to @Endpoint(...). |
| 04_scaling_performance/01_autoscaling/README.md | Updates autoscaling documentation tables/diagrams/config reference to new params. |
| 03_advanced_workers/README.md | Updates advanced workers overview to describe LB via Endpoint route decorators. |
| 03_advanced_workers/05_load_balancer/gpu_lb.py | Migrates GPU LB example to Endpoint route decorators (but introduces input-handling bug). |
| 03_advanced_workers/05_load_balancer/cpu_lb.py | Migrates CPU LB example to Endpoint route decorators. |
| 03_advanced_workers/05_load_balancer/README.md | Updates LB docs to Endpoint route decorators and QB vs LB explanation. |
| 02_ml_inference/01_text_to_speech/gpu_worker.py | Migrates TTS worker(s) to @Endpoint(...) (but introduces endpoint-name collision). |
| 02_ml_inference/01_text_to_speech/README.md | Updates TTS README references to @Endpoint. |
| 01_getting_started/README.md | Updates getting-started category README to Endpoint terminology. |
| 01_getting_started/04_dependencies/gpu_worker.py | Migrates dependency examples to @Endpoint(...) with deps/system deps. |
| 01_getting_started/04_dependencies/cpu_worker.py | Migrates CPU dependency examples to @Endpoint(...) and renames payload vars. |
| 01_getting_started/04_dependencies/README.md | Updates dependency-management docs to new Endpoint patterns and params. |
| 01_getting_started/03_mixed_workers/pipeline.py | Migrates pipeline LB endpoint to Endpoint(...).post() route decorator. |
| 01_getting_started/03_mixed_workers/gpu_worker.py | Migrates GPU inference worker to @Endpoint(...). |
| 01_getting_started/03_mixed_workers/cpu_worker.py | Migrates CPU workers to @Endpoint(...) (but introduces endpoint-name collision). |
| 01_getting_started/03_mixed_workers/README.md | Updates mixed-workers README to new patterns/params and shows new examples. |
| 01_getting_started/02_cpu_worker/cpu_worker.py | Migrates CPU hello worker to @Endpoint(...). |
| 01_getting_started/02_cpu_worker/README.md | Updates CPU worker README to @Endpoint and adds cpu enum/string guidance. |
| 01_getting_started/01_hello_world/gpu_worker.py | Migrates GPU hello worker to @Endpoint(...). |
| 01_getting_started/01_hello_world/README.md | Updates GPU hello README to @Endpoint and new scaling parameter names. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
flash-singh0
approved these changes
Mar 5, 2026
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.
Description
Updates all examples to reference this flash PR runpod/flash#223
Fixes AE-2259
Type of Change