Skip to content

docs: remove duplicate info froms README, remove flash run from instructions#43

Open
muhsinking wants to merge 3 commits intomainfrom
readme-duplication
Open

docs: remove duplicate info froms README, remove flash run from instructions#43
muhsinking wants to merge 3 commits intomainfrom
readme-duplication

Conversation

@muhsinking
Copy link
Contributor

Users in the UX study reported that it was unnecessary/confusing to have the conceptual information repeated in the flash examples readme.

Also restructured it to put "what is flash" after the getting started steps.

@muhsinking muhsinking requested a review from deanq March 11, 2026 14:59
@muhsinking muhsinking changed the title docs: remove duplicate info from Flash examples readme docs: remove duplicate info froms README, remove flash run from instructions Mar 11, 2026
@muhsinking muhsinking requested review from KAJdev March 11, 2026 17:20
Copy link
Contributor

@KAJdev KAJdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I got halfway through using individual comments, but the underlying theme is that there's a mismatch of python script.py and uv run script.py. We should prefer uv run in all cases.

That's the main thing I found. everything else looks okay.

# run with: flash run
# test directly: python gpu_worker.py
# GPU serverless worker -- detects available GPU hardware.
# Run: python gpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv run gpu_worker.py


```bash
uv run flash run
python gpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stay uv

### Test Worker Locally
### Run the Worker
```bash
python gpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

# run with: flash run
# test directly: python cpu_worker.py
# CPU serverless worker -- lightweight processing without GPU.
# Run: python cpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv


```bash
uv run flash run
python cpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

# run with: flash run
# test directly: python cpu_lb.py
# CPU load-balanced endpoints with custom HTTP routes.
# Run: python cpu_lb.py (test worker setup)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

# run with: flash run
# test directly: python gpu_lb.py
# GPU load-balanced endpoints with custom HTTP routes.
# Run: python gpu_lb.py (test worker setup)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

Comment on lines +46 to +49
python gpu_lb.py

# Test CPU load-balanced worker
python cpu_lb.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

# run with: flash run
# test directly: python cpu_worker.py
# CPU autoscaling strategies -- scale-to-zero and burst-ready.
# Run: python cpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

# run with: flash run
# test directly: python gpu_worker.py
# GPU autoscaling strategies -- scale-to-zero, always-on, high-throughput.
# Run: python gpu_worker.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uv

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants