From 0cf8eaedf1a078a5eeb0b115fecf36348c72bc4b Mon Sep 17 00:00:00 2001 From: Sungjin Date: Sun, 26 Apr 2026 12:27:35 +0900 Subject: [PATCH] Modify the way to present the FedOps-Launcher in docs. --- .../FedOps-Aggregation-method.md | 2 +- .../FedOps-Fitbit-Health-Pipeline.md | 2 +- .../FedOps-Hyperparameter-Optimize.md | 2 +- docs/FedOps-LLM/FedOps-LLM.md | 2 +- .../FedOps Launcher Overview.md | 22 -------------- docs/FedOps-XAI/FedOps-XAI.md | 2 +- .../FedOps-Launcher/FedOps-Launcher.md | 8 +++++ .../How-to-use-FedOps-Launcher.md | 29 ++++++++++--------- .../What-is-FedOps-Launcher.md | 22 ++++++++++++++ .../FlowerHub-with-GFedOps.md} | 6 ++-- .../What-is-FlowerHub.md | 18 ++++++++++++ .../FlowerHub with GFedOps/What-is-GFedOps.md | 19 ++++++++++++ 12 files changed, 90 insertions(+), 44 deletions(-) delete mode 100644 docs/FedOps-Launcher/FedOps Launcher Overview.md create mode 100644 docs/FlowerHub with GFedOps/FedOps-Launcher/FedOps-Launcher.md rename docs/{ => FlowerHub with GFedOps}/FedOps-Launcher/How-to-use-FedOps-Launcher.md (77%) create mode 100644 docs/FlowerHub with GFedOps/FedOps-Launcher/What-is-FedOps-Launcher.md rename docs/{FedOps-Launcher/FedOps-Launcher.md => FlowerHub with GFedOps/FlowerHub-with-GFedOps.md} (52%) create mode 100644 docs/FlowerHub with GFedOps/What-is-FlowerHub.md create mode 100644 docs/FlowerHub with GFedOps/What-is-GFedOps.md diff --git a/docs/FedOps-Aggregation-method/FedOps-Aggregation-method.md b/docs/FedOps-Aggregation-method/FedOps-Aggregation-method.md index 17c0d199e8..eadec023f9 100644 --- a/docs/FedOps-Aggregation-method/FedOps-Aggregation-method.md +++ b/docs/FedOps-Aggregation-method/FedOps-Aggregation-method.md @@ -1,7 +1,7 @@ --- layout: default title: FedOps Aggregation method -nav_order: 8 +nav_order: 7 has_children: true permalink: docs/FedOps-Aggregation-method --- diff --git a/docs/FedOps-Fitbit-Health-Pipeline/FedOps-Fitbit-Health-Pipeline.md b/docs/FedOps-Fitbit-Health-Pipeline/FedOps-Fitbit-Health-Pipeline.md index 496d708e27..0a50c9737a 100644 --- a/docs/FedOps-Fitbit-Health-Pipeline/FedOps-Fitbit-Health-Pipeline.md +++ b/docs/FedOps-Fitbit-Health-Pipeline/FedOps-Fitbit-Health-Pipeline.md @@ -1,7 +1,7 @@ --- layout: default title: FedOps Fitbit Health Pipeline -nav_order: 11 +nav_order: 10 has_children: true permalink: docs/FedOps-Fitbit-Health-Pipeline --- diff --git a/docs/FedOps-Hyperparameter-Optimize/FedOps-Hyperparameter-Optimize.md b/docs/FedOps-Hyperparameter-Optimize/FedOps-Hyperparameter-Optimize.md index d3748bc162..e12259559e 100644 --- a/docs/FedOps-Hyperparameter-Optimize/FedOps-Hyperparameter-Optimize.md +++ b/docs/FedOps-Hyperparameter-Optimize/FedOps-Hyperparameter-Optimize.md @@ -1,7 +1,7 @@ --- layout: default title: FedOps Clustering Tuning -nav_order: 9 +nav_order: 8 has_children: true permalink: docs/FedOps-Clustering-Tuning --- diff --git a/docs/FedOps-LLM/FedOps-LLM.md b/docs/FedOps-LLM/FedOps-LLM.md index 30e240d110..54b23d2b29 100644 --- a/docs/FedOps-LLM/FedOps-LLM.md +++ b/docs/FedOps-LLM/FedOps-LLM.md @@ -1,7 +1,7 @@ --- layout: default title: FedOps LLM -nav_order: 7 +nav_order: 6 has_children: true permalink: docs/FedOps-LLM --- diff --git a/docs/FedOps-Launcher/FedOps Launcher Overview.md b/docs/FedOps-Launcher/FedOps Launcher Overview.md deleted file mode 100644 index 0784f08e06..0000000000 --- a/docs/FedOps-Launcher/FedOps Launcher Overview.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: default -title: FedOps Launcher Overview -parent: FedOps Launcher -nav_order: 1 ---- -# 🎯 FedOps Launcher Overview -
- -![image.png](../../img/FedOps-Launcher/main_image.png) - -FedOps Launcher is a FedOps-based client execution environment designed to make it easier to run GFedOps Apps published on Flower App Hub and to naturally connect them to actual participation in federated learning. - -While platforms like Flower App Hub enable users to discover and reuse federated learning applications, participating as an actual federated client still requires complex environment setup and execution procedures. FedOps Launcher addresses this gap by providing an integrated execution environment that enables federated learning into an accessible and executable experience. - -By offering a containerized environment, FedOps Launcher removes the need for manual configuration of Python environments and dependencies, ensuring consistent and reproducible execution across systems. This allow users to focus on federated learning tasks rather than infrastructure, significantly lowering the barrier to entry for both beginners and experienced users. - -Building on Flower App Hub’s ecosystem, FedOps Launcher makes federated applications immediately executable in real participation scenarios. Users can import, modify, and prepare GFedOps Apps within an integrated environment, and simply turn into real participation. - -With a streamlined workflow, users can simply join federated learning tasks as clients with a single action, while local training, secure parameter exchange, and integration into the global model pipeline are handled automatically. In this way, FedOps Launcher serves as a practical execution that enables accessible, scalable, and truly participatory federated learning. - -**FedOps Launcher provides the execution foundation for accessible and real-participation federated learning by connecting application ecosystems with client-side execution environments.** \ No newline at end of file diff --git a/docs/FedOps-XAI/FedOps-XAI.md b/docs/FedOps-XAI/FedOps-XAI.md index 7651121d75..2d4b244e05 100644 --- a/docs/FedOps-XAI/FedOps-XAI.md +++ b/docs/FedOps-XAI/FedOps-XAI.md @@ -1,7 +1,7 @@ --- layout: default title: FedOps XAI -nav_order: 10 +nav_order: 9 has_children: true permalink: docs/FedOps-XAI --- diff --git a/docs/FlowerHub with GFedOps/FedOps-Launcher/FedOps-Launcher.md b/docs/FlowerHub with GFedOps/FedOps-Launcher/FedOps-Launcher.md new file mode 100644 index 0000000000..8016549069 --- /dev/null +++ b/docs/FlowerHub with GFedOps/FedOps-Launcher/FedOps-Launcher.md @@ -0,0 +1,8 @@ +--- +layout: default +title: FedOps Launcher +parent: FlowerHub with GFedOps +nav_order: 3 +has_children: true +--- +# FedOps Launcher \ No newline at end of file diff --git a/docs/FedOps-Launcher/How-to-use-FedOps-Launcher.md b/docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md similarity index 77% rename from docs/FedOps-Launcher/How-to-use-FedOps-Launcher.md rename to docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md index d0eded6fba..f7087b5c70 100644 --- a/docs/FedOps-Launcher/How-to-use-FedOps-Launcher.md +++ b/docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md @@ -2,6 +2,7 @@ layout: default title: How to use FedOps Launcher parent: FedOps Launcher +grand_parent: FlowerHub with GFedOps nav_order: 2 --- # 📝 FedOps Launcher Guide @@ -19,7 +20,7 @@ This guide provides step-by-step instructions for using FedOps Launcher, a FedOp [Docker Download](https://www.docker.com/get-started/) -![image.png](../../img/FedOps-Launcher/image(1).png) +![image.png](../../../img/FedOps-Launcher/image(1).png) **Windows users should run Docker in a WSL environment,** @@ -29,7 +30,7 @@ This guide provides step-by-step instructions for using FedOps Launcher, a FedOp 2.1 Default command -![image.png](../../img/FedOps-Launcher/image(2).png) +![image.png](../../../img/FedOps-Launcher/image(2).png) ```bash docker rm -f fedops-launcher 2>/dev/null; docker run -d --name fedops-launcher -p 5600:5600 -e WORKSPACE_DIR=/workspace -v "$HOME/fedops-workspace:/workspace" joseongjin311/fedops-launcher:v1.0.0 && echo "Now Running On: http://127.0.0.1:5600" @@ -51,11 +52,11 @@ docker rm -f fedops-launcher 2>/dev/null; docker run -d --name fedops-launcher - 3.1 Open your browser and enter [http://127.0.0.1:5600](http://127.0.0.1:5600) in URL bar -![image.png](../../img/FedOps-Launcher/image(3).png) +![image.png](../../../img/FedOps-Launcher/image(3).png) ### 4. Log in -![image.png](../../img/FedOps-Launcher/image(5).png) +![image.png](../../../img/FedOps-Launcher/image(5).png) 4.1 Use the same ID and password that you use on FedOps website @@ -65,7 +66,7 @@ docker rm -f fedops-launcher 2>/dev/null; docker run -d --name fedops-launcher - ### 5. Main functions of FedOps Launcher -![image.png](../../img/FedOps-Launcher/image(6).png) +![image.png](../../../img/FedOps-Launcher/image(6).png) 5.1 Start the FL client with these buttons @@ -87,15 +88,15 @@ Logout, **Save file**, Run Code. Go to Gfedops FlowerHub -![image.png](../../img/FedOps-Launcher/image(7).png) +![image.png](../../../img/FedOps-Launcher/image(7).png) 6.2 Select app you want to create -![image.png](../../img/FedOps-Launcher/image(8).png) +![image.png](../../../img/FedOps-Launcher/image(8).png) 6.3 Copy the command -![image.png](../../img/FedOps-Launcher/image(9).png) +![image.png](../../../img/FedOps-Launcher/image(9).png) 6.4 CreateFL @@ -103,25 +104,25 @@ Paste the command into the input box This will create the FL project in your directory. -![image.png](../../img/FedOps-Launcher/image(10).png) +![image.png](../../../img/FedOps-Launcher/image(10).png) 6.5 Install This installs the Python dependencies in your environment. -![image.png](../../img/FedOps-Launcher/image(11).png) +![image.png](../../../img/FedOps-Launcher/image(11).png) 6.6 Task If you are logged in, you can choose a Task what you created on FedOps website. -![image.png](../../img/FedOps-Launcher/image(12).png) +![image.png](../../../img/FedOps-Launcher/image(12).png) **"ssj" is my Task name, so you should select your own Task** Next, select the FL project to which you want to apply the Task. -![image.png](../../img/FedOps-Launcher/image(13).png) +![image.png](../../../img/FedOps-Launcher/image(13).png) **The selected Task must already be running on the FedOps website.** @@ -131,8 +132,8 @@ Next, select the FL project to which you want to apply the Task. All settings are complete. Just click the **Run** button. -![image.png](../../img/FedOps-Launcher/image(14).png) +![image.png](../../../img/FedOps-Launcher/image(14).png) **Thank you.** -**You have successfully started the FedOps Launcher.** \ No newline at end of file +**You have successfully started the FedOps Launcher.** diff --git a/docs/FlowerHub with GFedOps/FedOps-Launcher/What-is-FedOps-Launcher.md b/docs/FlowerHub with GFedOps/FedOps-Launcher/What-is-FedOps-Launcher.md new file mode 100644 index 0000000000..36590344e6 --- /dev/null +++ b/docs/FlowerHub with GFedOps/FedOps-Launcher/What-is-FedOps-Launcher.md @@ -0,0 +1,22 @@ +--- +layout: default +title: What is FedOps Launcher? +parent: FedOps Launcher +grand_parent: FlowerHub with GFedOps +nav_order: 1 +--- +# 🎯 FedOps Launcher Overview +
+ +FedOps Launcher is a tool that helps users run GFedOps Apps from FlowerHub more easily. After importing an app from FlowerHub, users can prepare the project in FedOps Launcher and run it as a real federated learning client. + +Normally, joining federated learning as a client requires several steps, such as setting up a Python environment, installing dependencies, editing code, selecting a FedOps task, and connecting to the FL server. FedOps Launcher brings these steps into one workspace. + +By using a containerized environment, FedOps Launcher also reduces Python version and dependency problems. In addition, instead of relying only on command-line execution, it provides a user-friendly Web UI so users can prepare and run client projects more easily. This allows users to focus more on the federated learning task and less on environment setup. + +Key points: + +- FedOps Launcher provides a Web UI for preparing and running GFedOps Apps. +- Users can import a GFedOps App from FlowerHub and create a local client project. +- It supports code editing, dependency installation, FedOps task selection, and client execution in one workspace. +- Users can join a FedOps federated learning task as a real client more easily. diff --git a/docs/FedOps-Launcher/FedOps-Launcher.md b/docs/FlowerHub with GFedOps/FlowerHub-with-GFedOps.md similarity index 52% rename from docs/FedOps-Launcher/FedOps-Launcher.md rename to docs/FlowerHub with GFedOps/FlowerHub-with-GFedOps.md index 3ce2a888d4..95a2d82588 100644 --- a/docs/FedOps-Launcher/FedOps-Launcher.md +++ b/docs/FlowerHub with GFedOps/FlowerHub-with-GFedOps.md @@ -1,8 +1,8 @@ --- layout: default -title: FedOps Launcher -nav_order: 6 +title: FlowerHub with GFedOps +nav_order: 11 has_children: true permalink: docs/FedOps-Launcher --- -# FedOps Launcher +# FlowerHub with GFedOps \ No newline at end of file diff --git a/docs/FlowerHub with GFedOps/What-is-FlowerHub.md b/docs/FlowerHub with GFedOps/What-is-FlowerHub.md new file mode 100644 index 0000000000..04800652cf --- /dev/null +++ b/docs/FlowerHub with GFedOps/What-is-FlowerHub.md @@ -0,0 +1,18 @@ +--- +layout: default +title: What is FlowerHub? +parent: FlowerHub with GFedOps +nav_order: 1 +--- +# 🎯 What is FlowerHub? +
+ +FlowerHub is like an app store for Flower Apps. Users can find, share, and reuse federated learning applications without building everything from the beginning. + +In the FedOps workflow, FlowerHub is the place where FedOps Client Apps can be published and imported. Users can bring these apps from FlowerHub and prepare them for real federated learning participation. + +Key points: + +- FlowerHub provides Flower Apps for federated learning. +- Users can import an app and reuse it as a project template. +- Apps can be modified for new tasks and shared with other users. diff --git a/docs/FlowerHub with GFedOps/What-is-GFedOps.md b/docs/FlowerHub with GFedOps/What-is-GFedOps.md new file mode 100644 index 0000000000..096d404c34 --- /dev/null +++ b/docs/FlowerHub with GFedOps/What-is-GFedOps.md @@ -0,0 +1,19 @@ +--- +layout: default +title: What is GFedOps? +parent: FlowerHub with GFedOps +nav_order: 2 +--- +# 🎯 What is GFedOps? +
+ +GFedOps is a collection of FedOps Apps developed by Gachon CCL and published on FlowerHub. If FlowerHub is like an app store for federated learning applications, GFedOps is the place where FedOps-related apps are shared. + +Users can bring GFedOps Apps from FlowerHub, create a FedOps client project, and run it with FedOps Launcher. This makes it easier to join federated learning without building the client code from scratch. + +Key points: + +- GFedOps provides FedOps-ready federated learning examples and client apps. +- Users can import a GFedOps App from FlowerHub and prepare it as a local client project. +- The client trains on local data and exchanges model updates with the federated learning server. +- GFedOps Apps can be executed more easily through FedOps Launcher. \ No newline at end of file