Skip to content

docs(framework): Document local SuperLink usage#6717

Merged
tanertopal merged 7 commits intomainfrom
update-docs-for-local-superlink
Mar 9, 2026
Merged

docs(framework): Document local SuperLink usage#6717
tanertopal merged 7 commits intomainfrom
update-docs-for-local-superlink

Conversation

@danieljanes
Copy link
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings March 8, 2026 19:35
@danieljanes danieljanes changed the title Update docs for local superlink docs(framework): Document local SuperLink usage Mar 8, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Flower documentation to reflect the “managed local SuperLink” local workflow, including the distinction between submitting runs vs streaming logs, and adds a dedicated how-to page for running Flower locally.

Changes:

  • Update tutorial/quickstart commands to use flwr run . --stream and adjust surrounding explanations to match the managed local SuperLink workflow.
  • Switch multiple quickstarts to install flwr[simulation] where the local simulation workflow is described.
  • Add a new how-to-run-flower-locally page and link it from the simulation docs toctree; refresh CLI naming/JSON output docs (flwr list).

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
framework/docs/source/tutorial-series-use-a-federated-learning-strategy-pytorch.rst Use --stream in run commands to align with local SuperLink log streaming.
framework/docs/source/tutorial-series-get-started-with-flower-pytorch.rst Update run instructions/output and explain managed local SuperLink behavior.
framework/docs/source/tutorial-series-customize-the-client-pytorch.rst Use --stream and clarify non-streaming behavior with link to local workflow doc.
framework/docs/source/tutorial-series-build-a-strategy-from-scratch-pytorch.rst Use --stream and clarify non-streaming behavior with link to local workflow doc.
framework/docs/source/tutorial-quickstart-xgboost.rst Update local workflow explanation, install extra, and streamed run output.
framework/docs/source/tutorial-quickstart-tensorflow.rst Update local workflow explanation, install extra, and streamed run output.
framework/docs/source/tutorial-quickstart-scikitlearn.rst Update local workflow explanation, install extra, and streamed run output.
framework/docs/source/tutorial-quickstart-pytorch.rst Update local workflow explanation, install extra, and streamed run output.
framework/docs/source/tutorial-quickstart-pytorch-lightning.rst Update local workflow explanation and streamed run output.
framework/docs/source/tutorial-quickstart-mlx.rst Update local workflow explanation, install extra, and streamed run output.
framework/docs/source/tutorial-quickstart-jax.rst Update local workflow explanation, install extra, and streamed run output.
framework/docs/source/tutorial-quickstart-ios.rst Update install command to flwr[simulation].
framework/docs/source/tutorial-quickstart-huggingface.rst Update local workflow explanation, install extra, streamed output, and GPU run uses --stream.
framework/docs/source/tutorial-quickstart-fastai.rst Update local workflow explanation and streamed run output.
framework/docs/source/simulate.rst Add how-to-run-flower-locally to the simulation how-to toctree.
framework/docs/source/ref-flower-runtime-comparison.rst Update runtime comparison text to reflect managed local SuperLink local workflow.
framework/docs/source/ref-flower-configuration.rst Update CLI command naming (flwr list) and clarify local profile behavior with link to local workflow doc.
framework/docs/source/how-to-use-cli-json-output.rst Refresh JSON-output guide for flwr run/flwr list/flwr stop and managed local SuperLink context.
framework/docs/source/how-to-run-simulations.rst Update wording from Simulation Engine to Simulation Runtime + managed local SuperLink lifecycle details.
framework/docs/source/how-to-run-flower-with-deployment-engine.rst Clarify default local profile behavior vs deployment runtime usage.
framework/docs/source/how-to-run-flower-locally.rst New how-to page documenting managed local SuperLink local workflow and lifecycle.
framework/docs/source/how-to-configure-audit-logging.rst Update example command naming/log text from flwr ls to flwr list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot added the Maintainer Used to determine what PRs (mainly) come from Flower maintainers. label Mar 8, 2026
@tanertopal tanertopal enabled auto-merge (squash) March 9, 2026 19:45
@tanertopal tanertopal merged commit f540ed4 into main Mar 9, 2026
71 checks passed
@tanertopal tanertopal deleted the update-docs-for-local-superlink branch March 9, 2026 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintainer Used to determine what PRs (mainly) come from Flower maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants