refactor(examples): Update README.md in examples#6890
Merged
Conversation
jafermarq
requested review from
chongshenng,
danieljanes,
panh99,
tanertopal and
yan-gao-GY
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Updates multiple example READMEs to reflect the latest recommended Flower CLI usage for running simulations, including streaming output and configuring simulation runtime via the flwr federation simulation-config command.
Changes:
- Add
--streamtoflwr runcommands across examples. - Replace manual SuperLink configuration instructions (editing
config.toml) withflwr federation simulation-configCLI commands in several READMEs. - Adjust simulation setup text to describe required virtual
SuperNodesfor different examples.
Reviewed changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/xgboost-comprehensive/README.md | Adds --stream to simulation run commands. |
| examples/whisper-federated-finetuning/README.md | Reworks simulation setup to use flwr federation simulation-config and adds --stream. |
| examples/vertical-fl/README.md | Switches setup instructions to flwr federation simulation-config and updates wording. |
| examples/quickstart-xgboost/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-tensorflow/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-sklearn/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-pytorch/README.md | Adds --stream and adjusts GPU-related tip text. |
| examples/quickstart-pytorch-lightning/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-pennylane/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-pandas/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-numpy/README.md | Adds --stream to flwr run command. |
| examples/quickstart-monai/README.md | Adds --stream and introduces flwr federation simulation-config for GPU resources. |
| examples/quickstart-mlx/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-jax/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-huggingface/README.md | Adds --stream and introduces flwr federation simulation-config usage. |
| examples/quickstart-fastai/README.md | Adds --stream to flwr run commands. |
| examples/quickstart-catboost/README.md | Adds --stream to flwr run commands. |
| examples/opacus/README.md | Adds --stream to flwr run commands. |
| examples/flowertune-vit/README.md | Adds --stream and replaces GPU config guidance with flwr federation simulation-config. |
| examples/flowertune-llm/README.md | Introduces flwr federation simulation-config and adds --stream to run commands. |
| examples/flowertune-llm-medical/README.md | Replaces SuperLink TOML guidance with flwr federation simulation-config and adds --stream. |
| examples/flowertune-llm-general-nlp/README.md | Replaces SuperLink TOML guidance with flwr federation simulation-config and adds --stream. |
| examples/flowertune-llm-finance/README.md | Replaces SuperLink TOML guidance with flwr federation simulation-config and adds --stream. |
| examples/flowertune-llm-code/README.md | Replaces SuperLink TOML guidance with flwr federation simulation-config and adds --stream. |
| examples/flower-secure-aggregation/README.md | Adds --stream to flwr run commands. |
| examples/fl-tabular/README.md | Switches setup instructions to flwr federation simulation-config and adds --stream. |
| examples/fl-dp-sa/README.md | Switches setup instructions to flwr federation simulation-config and adds --stream to run-config example. |
| examples/fedrag/README.md | Switches setup instructions to flwr federation simulation-config and adds --stream. |
| examples/federated-vae/README.md | Adds --stream to flwr run commands. |
| examples/federated-kaplan-meier-fitter/README.md | Switches setup instructions to flwr federation simulation-config and adds --stream. |
| examples/advanced-pytorch/README.md | Adds flwr federation simulation-config --num-supernodes=50 and appends --stream to flwr run. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
github-actions
bot
added
the
Maintainer
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
yan-gao-GY
reviewed
Apr 1, 2026
Member
yan-gao-GY
left a comment
yan-gao-GY
left a comment
There was a problem hiding this comment.
LGTM! I left a few comments to fix the typos
Co-authored-by: Yan Gao <yan@flower.ai>
panh99
approved these changes
Apr 2, 2026
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.
--streamtoflwr runcommandSuperLinkConnectionwithoptions.fileds