docs: clarify Flash Endpoint gpu= single-type vs list placement semantics - #817
Draft
justinwlin wants to merge 1 commit into
Draft
docs: clarify Flash Endpoint gpu= single-type vs list placement semantics#817justinwlin wants to merge 1 commit into
justinwlin wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
The Flash SDK's
Endpoint(gpu=)accepts aGpuGroup, aGpuType, or a list of either, and the docs previously presented all three (and especially a list) as an ordered fallback of exact GPU models. In practice, a singleGpuTypeis the only form guaranteed to pin workers to a specific card, while a list is treated at the pool/VRAM-tier level: the SDK converts each listedGpuTypeto its GPU pool when creating the endpoint (excluding unlisted pool members) and does not preserve list order, so workers may run on a different card with equivalent VRAM rather than one of the exact models listed — and no API field reports which GPU a worker was actually placed on. This PR documents that distinction everywheregpu=semantics are described.Fixes runpod/flash#366
Internal: CON-1231
What changed
flash/configuration/gpu-types.mdxGpuType= exact card (only guaranteed pin); singleGpuGroup= any card in the pool; a list = any of the listed options, treated at the pool/VRAM-tier level, advisory placement, order not preserved.nvidia-smi).GpuTypeand hybrid examples ("Try X first / fall back to Y").flash/configuration/parameters.mdx(### gpureference): same single-vs-list semantics as bullets, plus the no-placed-GPU-field Note; kept existing examples.flash/create-endpoints.mdx(GPU vs CPU): clarified the multi-type example and added a sentence on exact-card placement with a link to the behavior section.flash/troubleshooting.mdx(GPU availability): dropped the inaccurate "First choice / Fallback / Second fallback" order comments and cross-linked the behavior section.Wording was checked against the SDK source (
GpuGroup.to_gpu_ids_strincore/resources/gpu.py,_sync_input_fields_gpuincore/resources/serverless.py,_normalize_gpuinendpoint.pyon runpod/flash @ 26263c7): client side,GpuTypevalues map to pool IDs plus negations for unlisted pool members, and thegpuIdsstring is normalized so order is not preserved. The placement-guarantee statements are attributed to observed platform behavior (reported in runpod/flash#366: aGpuTypelist landed on a different equivalent-VRAM card 7/7; a singleGpuTypepinned the card 7/7).How verified
node scripts/validate-tooltips.js— passes (only pre-existing unused-import warnings on unrelated pages).node scripts/validate-redirect-sources.js— passes (293 redirects validated)..claude/style-guide.md(second person, active voice, sentence-case headings) and reuse the<Note>/<Tip>components already used on neighboring Flash pages.For the reviewer
flash/configuration/gpu-types.mdx(e.g.AMPERE_24,ADA_24membership) don't match the SDK'sPOOLS_TO_TYPESmapping (e.g. SDK hasADA_24= RTX 4090 only,AMPERE_24= A5000/L4/3090). The tables may reflect the live API rather than the SDK enum — worth confirming separately.