Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: FedOps Aggregation method
nav_order: 8
nav_order: 7
has_children: true
permalink: docs/FedOps-Aggregation-method
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: FedOps Clustering Tuning
nav_order: 9
nav_order: 8
has_children: true
permalink: docs/FedOps-Clustering-Tuning
---
Expand Down
2 changes: 1 addition & 1 deletion docs/FedOps-LLM/FedOps-LLM.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: FedOps LLM
nav_order: 7
nav_order: 6
has_children: true
permalink: docs/FedOps-LLM
---
Expand Down
22 changes: 0 additions & 22 deletions docs/FedOps-Launcher/FedOps Launcher Overview.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/FedOps-XAI/FedOps-XAI.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: FedOps XAI
nav_order: 10
nav_order: 9
has_children: true
permalink: docs/FedOps-XAI
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: FedOps Launcher
parent: FlowerHub with GFedOps
nav_order: 3
has_children: true
---
# FedOps Launcher
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,**

Expand All @@ -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"
Expand All @@ -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

Expand All @@ -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

Expand All @@ -87,41 +88,41 @@ 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

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.**

Expand All @@ -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.**
**You have successfully started the FedOps Launcher.**
Original file line number Diff line number Diff line change
@@ -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
<br />

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.
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions docs/FlowerHub with GFedOps/What-is-FlowerHub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
title: What is FlowerHub?
parent: FlowerHub with GFedOps
nav_order: 1
---
# 🎯 What is FlowerHub?
<br />

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.
19 changes: 19 additions & 0 deletions docs/FlowerHub with GFedOps/What-is-GFedOps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: default
title: What is GFedOps?
parent: FlowerHub with GFedOps
nav_order: 2
---
# 🎯 What is GFedOps?
<br />

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.
Loading