Skip to content

refactor(examples): Migrate examples to hub/apps & update links#6866

Open
yan-gao-GY wants to merge 12 commits intomainfrom
remove-examples-dir
Open

refactor(examples): Migrate examples to hub/apps & update links#6866
yan-gao-GY wants to merge 12 commits intomainfrom
remove-examples-dir

Conversation

@yan-gao-GY
Copy link
Copy Markdown
Member

Proposal

Migrate examples to hub/apps & update links.

Copilot AI review requested due to automatic review settings March 27, 2026 10:28
Copy link
Copy Markdown
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

Migrates Flower example apps from examples/ into hub/apps/ and updates repository tooling/docs to point to the new locations.

Changes:

  • Repointed docs (Framework/Datasets/Swift) and root READMEs from examples/** to hub/apps/**
  • Updated dev tooling/CI scripts (format/test/version bump/e2e) to operate on hub/apps/
  • Added a new hub/apps/demo app scaffold (NumPy quickstart-style)

Reviewed changes

Copilot reviewed 53 out of 641 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
hub/apps/flowertune-llm-finance Removes previous symlink target to examples/
hub/apps/flowertune-llm-code Removes previous symlink target to examples/
hub/apps/flower-secure-aggregation Removes previous symlink target to examples/
hub/apps/fl-tabular Removes previous symlink target to examples/
hub/apps/fl-dp-sa Removes previous symlink target to examples/
hub/apps/demo/quickstart_numpy/task.py Adds dummy model helper for the demo app
hub/apps/demo/quickstart_numpy/server_app.py Adds ServerApp entrypoint for the demo app
hub/apps/demo/quickstart_numpy/client_app.py Adds ClientApp train/eval handlers for the demo app
hub/apps/demo/quickstart_numpy/init.py Adds package marker/docstring
hub/apps/demo/pyproject.toml Adds app packaging metadata and Flower config
hub/apps/demo/README.md Adds run instructions for the new demo app
hub/apps/custom-mods Removes previous symlink target to examples/
glossary/edge-computing.mdx Updates embedded-devices link to hub/apps
framework/swift/flwr/README.md Updates iOS example link to hub/apps/ios
framework/docs/source/tutorial-quickstart-xgboost.rst Updates quickstart code link to hub/apps
framework/docs/source/tutorial-quickstart-tensorflow.rst Updates quickstart code link to hub/apps
framework/docs/source/tutorial-quickstart-scikitlearn.rst Updates quickstart code links to hub/apps
framework/docs/source/tutorial-quickstart-pytorch.rst Updates quickstart code link to hub/apps
framework/docs/source/tutorial-quickstart-pytorch-lightning.rst Updates clone/link paths to hub/apps
framework/docs/source/tutorial-quickstart-pandas.rst Updates quickstart code link to hub/apps
framework/docs/source/tutorial-quickstart-mlx.rst Updates quickstart code link to hub/apps
framework/docs/source/tutorial-quickstart-jax.rst Updates quickstart code link to hub/apps
framework/docs/source/tutorial-quickstart-ios.rst Updates iOS example links to hub/apps/ios
framework/docs/source/tutorial-quickstart-huggingface.rst Updates quickstart/flowertune links to hub/apps
framework/docs/source/tutorial-quickstart-fastai.rst Updates clone/link paths to hub/apps
framework/docs/source/tutorial-quickstart-android.rst Updates Android example link to hub/apps/android
framework/docs/source/ref-faq.rst Updates embedded-devices link to hub/apps
framework/docs/source/ref-example-projects.rst Updates links to hub/apps and removes one example section
framework/docs/source/how-to-use-strategies.rst Updates quickstart link to hub/apps
framework/docs/source/how-to-use-differential-privacy.rst Updates opacus link to hub/apps
framework/docs/source/how-to-upgrade-to-message-api.rst Updates quickstart link to hub/apps
framework/docs/source/how-to-upgrade-to-flower-1.0.rst Updates examples root link to hub/apps
framework/docs/source/how-to-save-and-load-model-checkpoints.rst Updates advanced-pytorch link to hub/apps
framework/docs/source/how-to-run-simulations.rst Updates multiple example links to hub/apps
framework/docs/source/how-to-migrate-from-openfl.rst Updates examples root link to hub/apps
framework/docs/source/how-to-enable-tls-connections.rst Updates TLS/auth example link to hub/apps
framework/docs/source/how-to-authenticate-supernodes.rst Updates auth example link to hub/apps
framework/docs/source/explanation-federated-evaluation.rst Updates advanced-pytorch link to hub/apps
framework/docs/source/docker/tutorial-deploy-on-multiple-machines.rst Updates quickstart-sklearn paths to hub/apps
framework/docs/source/docker/run-quickstart-examples-docker-compose.rst Updates clone/move paths to hub/apps
framework/docs/source/contributor-how-to-set-up-a-virtual-env.rst Updates “examples” reference to “apps” (hub/apps)
framework/dev/update_version.py Updates version bump glob from examples/** to hub/apps/**
framework/README.md Updates example links to hub/apps and trims one item
dev/test.sh Updates lint/format targets from examples to hub
dev/swift-docs-resources/footer.html Updates C++ quickstart link to hub/apps
dev/format.sh Updates formatting targets from examples to hub/apps
dev/devtool/build_example_docs.py Updates “View on GitHub” link base to hub/apps
datasets/docs/source/recommended-fl-datasets.rst Updates quickstart-pytorch link to hub/apps
datasets/README.md Updates “Flower Examples page” link to hub/apps
README.md Updates example links to hub/apps and trims one item
.github/workflows/framework-test.yml Updates path filters from examples/**/* to hub/apps/**/*
.github/workflows/framework-e2e.yml Updates working-directory from examples/ to hub/apps/
.github/CODEOWNERS Adds hub/ ownership block
Comments suppressed due to low confidence (1)

hub/apps/flowertune-llm-finance:1

  • This file previously looks like a Git symlink target (content is a relative path). The diff removes the only line, which typically results in an invalid/empty symlink target (or an empty file, depending on file mode), breaking navigation/discovery. If this app was migrated, this entry should either be deleted entirely or replaced with the actual app directory/content (or updated symlink target) instead of becoming empty. Please also verify the other similar entries changed in this PR (e.g., hub/apps/flowertune-llm-code, hub/apps/fl-tabular, etc.).

💡 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 27, 2026
yan-gao-GY and others added 3 commits March 27, 2026 19:04
panh99
panh99 previously approved these changes Mar 27, 2026
Copy link
Copy Markdown
Member

@panh99 panh99 left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

5 participants