Repository navigation
docs(flash): match the quickstart and tutorials to a live run on runpod-flash 1.21.0 - #923
Open
justinwlin wants to merge 10 commits into
Open
justinwlin wants to merge 10 commits into
justinwlin wants to merge 10 commits into
Conversation
Since runpod-flash 1.15.0, calling an @endpoint function from a plain script resolves an already-deployed endpoint and fails with "endpoint not found" until flash deploy runs. Add the deploy step, drop the stale provisioning output, keep the __main__ block in the Step 7 snippet, warn that torch-dependent packages bloat the local build, and correct the Python version guidance (local 3.10-3.14, workers default to 3.12).
…quickstart - Text generation tutorial: add the flash deploy step and drop stale provisioning output. - SDXL tutorial: install pillow, which save_image imports locally. - Endpoint has no python_version parameter; document --python-version as the only way to change the worker Python version. - deploy.mdx: numpy is not auto-excluded from builds. - Troubleshooting: replace the unreachable Python 3.9 error with the real --python-version error. - deploy-apps.mdx: replace the removed 'no flash context' error with the endpoint-not-found error.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This was referenced Oct 26, 2026
justinwlin
marked this pull request as ready for review
October 26, 2026 22:19
lavanya-gunreddi
previously approved these changes
Oct 27, 2026
…od-flash 1.21.0 - cache the model per worker in the SDXL and text-generation tutorials - drop accelerate and python-dotenv, use max_new_tokens, add complete files - replace guessed timings and outputs with measured ones - document the 90-second first-run failure (timeout or KeyError) and the health check, and stop recommending FLASH_SENTINEL_TIMEOUT - add calling the endpoint over HTTP with /run and /status - fix the flash init layout, stale model IDs, the network volume cache, and troubleshooting error text
…_version - run the quickstart's matrix multiply on the GPU with torch instead of numpy on the worker CPU, and update the deploy output from a live run - tell readers to redeploy after switching to SDXL Turbo, with a runnable call - document python_version resolution: flag, resource config, then 3.12, and the conflict error
- curl needs RUNPOD_API_KEY exported; flash login doesn't set it - troubleshooting: scripts don't provision endpoints, run flash deploy first - build page: torch packages come from GPU images, not CPU images - quickstart Step 8: requests are sent together, execution depends on workers
This branch was successfully deployed
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.
Note
Companion PR: runpod/flash#394. This PR documents
runpod-flash1.21.0 as released, including the 90-second first-run failure and the brokenflash deploycurl example. #394 fixes both in the SDK. The pages were tested in the same live runs. Review them together, and revisit the 90-second guidance once #394 ships.Brings the Flash quickstart and the SDXL and text-generation tutorials in line with what actually happens on
runpod-flash1.21.0. Every page was run end to end against live endpoints, and the code, outputs, and timings come from those runs.What changed
flash deploybefore the script. Since 1.15.0, calling an@Endpointfunction looks up a deployed endpoint, so without it the first run fails withendpoint ... not found. Each page shows the real deploy output.global) and reportmodel_cached. Warm SDXL calls went from about 25s to 7s end to end. Both have a "Complete file" accordion that matches the steps.accelerateis gone from both tutorials. It pullstorchand several GB of CUDA wheels into the local build on Linux, which is the "Disk quota exceeded" failure. SDXL builds to 50 MB and GPT-2 to 38 MB.timed out after 90s ... may not be deployed, orKeyErroron the output. The fix is to run the script again.FLASH_SENTINEL_TIMEOUTis no longer recommended because above 90 it turns the timeout into theKeyError. Also covers the/healthcheck (throttledmeans waiting for a GPU)./runand/statuscurl calls (including exportingRUNPOD_API_KEY, whichflash logindoesn't set), and a warning that{"input": {}}(the exampleflash deployprints in 1.21.0) fails after about 40s.torch. Before, it usednumpyon the worker's CPU and only read the GPU name.max_new_tokensinstead ofmax_lengthflash initlayout (gpu_worker.py, notworkers/gpu/endpoint.py)stabilityai/stable-diffusion-2-1returns 401)HF_HOME, so models are actually cachedendpoint defined in multiple fileserror--python-version, thenpython_versionon a resource config such asLiveServerless, then 3.12. A conflict fails the build.@Endpointhas nopython_versionparameter.Verification
KeyErrorwithFLASH_SENTINEL_TIMEOUT=300, the 401 without credentials,{"input": {}}failing after 40s, anddefined in multiple files. All test endpoints and apps were deleted afterwards.mintlify broken-linksfound none. The only parse error is inREADME.md, which was already there.Related Flash PRs
runpod-flashstops getting fixes on 2026-10-29, so therunpod/flashchanges need to merge and release before then.torchvisionin the GPU load-balancer imageflash buildarchivesflash deployapikeyas a credentials fallback