Skip to content

Commit 6f0e5c1

Browse files
committed
docs(cli): document parity-by-default and 3.13 in --python-version help
Phase 3 of AE-2827. Updates the Options bullet for --python-version on both flash build and flash deploy docs to reflect the new behavior: local interpreter is the default; 3.13 is now in the supported set. Refs AE-2827.
1 parent 0c3635a commit 6f0e5c1

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/runpod_flash/cli/docs/flash-build.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ flash build [OPTIONS]
2828
- `--no-deps`: Skip transitive dependencies during pip install (default: false)
2929
- `--output, -o`: Custom archive name (default: artifact.tar.gz)
3030
- `--exclude`: Comma-separated packages to exclude (e.g., 'torch,torchvision')
31-
- `--python-version`: Target Python version for worker images (`3.10`, `3.11`, or `3.12`). Overrides per-resource `python_version`. Default: value declared on resource configs, or 3.12 if none set.
31+
- `--python-version`: Target Python version for worker images (`3.10`, `3.11`, `3.12`, or `3.13`). Overrides per-resource `python_version` declarations and the local-interpreter default. By default, `flash build` targets the Python version you're running flash from.
3232

3333
To launch a local preview environment, use `flash deploy --preview` instead.
3434

@@ -68,7 +68,7 @@ After `flash build` completes:
6868
Flash automatically handles cross-platform builds, ensuring compatibility with Runpod's Linux x86_64 serverless infrastructure:
6969

7070
- **Automatic Platform Targeting**: Dependencies are always installed for Linux x86_64, regardless of your build platform (macOS, Windows, or Linux)
71-
- **Python Version**: Targets Python 3.12 for wheel ABI selection regardless of local interpreter
71+
- **Python Version**: Targets the resolved Python version (your local interpreter by default, or whatever `--python-version` / per-resource `python_version` selects) for wheel ABI selection
7272
- **Binary Wheel Enforcement**: Only pre-built binary wheels are used, preventing platform-specific compilation issues
7373

7474
This means you can safely build on macOS ARM64, Windows, or any platform, and the deployment will work correctly on Runpod.
@@ -181,8 +181,8 @@ ls .flash/.build/my-project/
181181
If a package doesn't have pre-built Linux x86_64 wheels:
182182

183183
1. **Install standard pip**: `python -m ensurepip --upgrade` -- standard pip has better manylinux compatibility than uv pip
184-
2. **Check package availability**: Visit PyPI and verify the package has Linux wheels for Python 3.12
185-
3. **Python 3.12**: All flash workers run Python 3.12. Ensure packages are available for this version.
184+
2. **Check package availability**: Visit PyPI and verify the package has Linux wheels for your target Python version (`3.10`, `3.11`, `3.12`, or `3.13`)
185+
3. **Match interpreter**: Flash builds default to your local Python version. If a wheel is missing for that version, either pick a different `--python-version` or upgrade/downgrade the package.
186186
4. **Pure-Python packages**: These work regardless, as they don't require platform-specific builds
187187

188188
## Managing Deployment Size

src/runpod_flash/cli/docs/flash-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ flash deploy [OPTIONS]
8888
- `--exclude`: Comma-separated packages to exclude (e.g., 'torch,torchvision')
8989
- `--output, -o`: Custom archive name (default: artifact.tar.gz)
9090
- `--preview`: Build and launch local preview environment instead of deploying
91-
- `--python-version`: Target Python version for worker images (`3.10`, `3.11`, or `3.12`). Overrides per-resource `python_version`.
91+
- `--python-version`: Target Python version for worker images (`3.10`, `3.11`, `3.12`, or `3.13`). Overrides per-resource `python_version` declarations and the local-interpreter default. By default, `flash deploy` targets the Python version you're running flash from.
9292

9393
## Examples
9494

0 commit comments

Comments
 (0)