docs: Add Flash to apps SDK migration guide and deprecation notices#704
docs: Add Flash to apps SDK migration guide and deprecation notices#704promptless[bot] wants to merge 1 commit into
Conversation
- New flash/migrate-to-apps-sdk.mdx: decorator/CLI mapping, config parity, call methods, what's not carried over - Deprecation notices on flash/overview and flash/cli/overview - Draft (commented) changelog entry for the apps SDK release + breaking rp CLI changes - Nav entry in docs.json Grounded in runpod/runpod-python#534 (unreleased).
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| | --- | --- | --- | | ||
| | Package | `pip install runpod-flash` | `pip install runpod` | | ||
| | Import | `from runpod_flash import Endpoint` | `import runpod` and `from runpod import App` | | ||
| | Decorator | `@Endpoint(...)` | `@app.queue(...)`, `@app.api(...)`, or `@app.task(...)` | |
There was a problem hiding this comment.
The three decorators and their mapping from Flash's @Endpoint come from App.queue, App.api, and App.task in runpod/apps/app.py; @app.task provisions an ephemeral pod per call while @app.queue/@app.api back Serverless endpoints.
Source: https://github.com/runpod/runpod-python/blob/feat/apps-sdk/runpod/apps/app.py
| return {"mean": float(np.mean(np.random.rand(size, size)))} | ||
|
|
||
| @runpod.local_entrypoint | ||
| def main(): |
There was a problem hiding this comment.
The call methods (.remote(), .remote.aio(), .spawn() returning a Job, and .local()) and the fact that calling a handle directly raises TypeError are defined on FunctionHandle in runpod/apps/handles.py.
Source: https://github.com/runpod/runpod-python/blob/feat/apps-sdk/runpod/apps/handles.py
| You can also call one function's `.remote()` from inside another function's body to build cross-endpoint pipelines: the nested call runs on the sibling resource. | ||
|
|
||
| ## Step 4: Update your CLI commands | ||
|
|
There was a problem hiding this comment.
The rp CLI command set (login, init, dev, deploy, app, env, undeploy, update, plus the new logs --follow, secret, and registry groups) is defined in runpod/rp_cli/main.py; the entrypoint is registered as both rp and runpod in setup.py.
Source: https://github.com/runpod/runpod-python/blob/feat/apps-sdk/runpod/rp_cli/main.py
|
|
||
| The decorator configuration surface carries over directly. The following parameters are available on `@app.queue` (and, except where noted, on `@app.api` and `@app.task`): | ||
|
|
||
| | Parameter | Description | |
There was a problem hiding this comment.
The configuration parity table's defaults and constraints (workers default (0, 3), idle_timeout=60, scaler_value=4, max_concurrency queue-only, min_cuda_version set 11.8–13.0, gpu/cpu mutual exclusion, model= unsupported on tasks) come from ResourceSpec normalization/validation in runpod/apps/spec.py.
Source: https://github.com/runpod/runpod-python/blob/feat/apps-sdk/runpod/apps/spec.py
|
|
||
| This opens your browser to approve the login. After you approve, your API key is saved to `~/.runpod/config.toml` for the `rp` CLI and the SDK. | ||
|
|
||
| <Tip> |
There was a problem hiding this comment.
The rp login browser-approval flow, the --api-key direct-store option, and credentials being saved to ~/.runpod/config.toml (with RUNPOD_API_KEY as the fallback) come from browser_login in runpod/apps/auth.py and the login command in runpod/rp_cli/main.py.
Source: https://github.com/runpod/runpod-python/blob/feat/apps-sdk/runpod/apps/auth.py
|
|
||
| - A [Runpod account](/get-started/manage-accounts) with a verified email address. | ||
| - A [Runpod API key](/get-started/api-keys) with **All** access permissions. | ||
| - [Python 3.10, 3.11, 3.12, 3.13, or 3.14](https://www.python.org/downloads/) installed. |
There was a problem hiding this comment.
The supported Python versions (3.10–3.14) in the Requirements section come from SUPPORTED_PYTHON_VERSIONS in runpod/apps/images.py, which is the range the per-python runtime images are built for.
Source: https://github.com/runpod/runpod-python/blob/feat/apps-sdk/runpod/apps/images.py
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Open this suggestion in Promptless to view citations and reasoning process
Documents the apps SDK (successor to runpod-flash in the core
runpodpackage) from runpod/runpod-python#534. Adds a new migration guide (flash/migrate-to-apps-sdk.mdx) mapping@Endpoint→@app.queue/@app.api/@app.task, theflash→rpCLI, call methods, full config parity, and what's not carried over. Adds deprecation notices to the Flash overview and CLI overview, and a draft (commented-out) changelog entry. The PR is unreleased/release-gated (apps SDK not yet on PyPI), so the guide is framed as a ready-to-publish draft with a preview note; the reviewer publishes at release time.Trigger Events
Tip: Point @Promptless at some of your docs debt and have it clean them up in the background 🧹