diff --git a/docs/FedOps-VLM/How-to-use-FedOps-VLM-Framework.md b/docs/FedOps-VLM/How-to-use-FedOps-VLM-Framework.md index ec7027013b..7f99da7af2 100644 --- a/docs/FedOps-VLM/How-to-use-FedOps-VLM-Framework.md +++ b/docs/FedOps-VLM/How-to-use-FedOps-VLM-Framework.md @@ -81,7 +81,7 @@ Now open a new terminal in the same folder path, and run ## **4. Server Side Code Management** -Visit: https://ccl.gachon.ac.kr/fedops/task +Visit: [FedOps Task Page](https://ccl.gachon.ac.kr/fedops/task) signin and create a task named task id: ***”fedopstune2”***. and do the followings diff --git a/docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md b/docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md index e0a44603b7..8a31d1d5e4 100644 --- a/docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md +++ b/docs/FlowerHub with GFedOps/FedOps-Launcher/How-to-use-FedOps-Launcher.md @@ -16,7 +16,7 @@ This guide provides step-by-step instructions for using FedOps Launcher, a FedOp --- -### 1. Install Docker +### 1. Install Docker FedOps Launcher runs as a Docker container. Docker is required to provide an isolated execution environment for the launcher, manage the workspace volume, and run the FL client consistently across different operating systems. @@ -24,11 +24,9 @@ FedOps Launcher runs as a Docker container. Docker is required to provide an iso ![image.png](../../../img/FedOps-Launcher/image(1).png) -**Windows users should run Docker in a WSL environment,** +**For Windows users, we recommend running Docker in a WSL environment because Docker is generally more stable in Unix-based environments such as macOS and Linux.** -**because Docker is generally more stable in Unix-based environments such as macOS and Linux.** - -### 2. Run the command in a CLI environment +### 2. Run the command in a terminal 2.1 Default command @@ -38,11 +36,11 @@ FedOps Launcher runs as a Docker container. Docker is required to provide an iso 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" ``` -The examples in this guide are performed in VSCode within a Linux environment provided by Windows WSL. +The examples in this guide are performed in VS Code within the Linux environment provided by Windows WSL. -Just copy the command and run it in your CLI environment. +Copy the command and run it in your terminal. -2.2 Command for using GPU +2.2 Command for GPU usage **If your environment does not have an NVIDIA GPU, an error will occur.** @@ -52,7 +50,7 @@ docker rm -f fedops-launcher 2>/dev/null; docker run -d --name fedops-launcher - ### 3. Open your browser and connect to FedOps Launcher -3.1 Open your browser and enter [http://127.0.0.1:5600](http://127.0.0.1:5600) in URL bar +3.1 Open your browser and enter [http://127.0.0.1:5600](http://127.0.0.1:5600) in the address bar. ![image.png](../../../img/FedOps-Launcher/image(3).png) @@ -60,51 +58,51 @@ docker rm -f fedops-launcher 2>/dev/null; docker run -d --name fedops-launcher - ![image.png](../../../img/FedOps-Launcher/image(5).png) -4.1 Use the same ID and password that you use on FedOps website +4.1 Use the same ID and password that you use on the FedOps website. -4.2 You can also continue in Guest mode +4.2 You can also continue in Guest mode. -**In Guest mode, you cannot load the Task info what you created on the FedOps website.** +**In Guest mode, you cannot load Task information created on the FedOps website.** ### 5. Main functions of FedOps Launcher ![image.png](../../../img/FedOps-Launcher/image(6).png) -5.1 Start the FL client with these buttons +5.1 Start the FL client using these buttons. -5.2 Manage file system +5.2 Manage the file system. -5.3 View logs and execute commands in terminal +5.3 View logs and execute commands in the terminal. -5.4 Edit code +5.4 Edit code. -5.5 Extra buttons +5.5 Use the extra buttons. -Logout, **Save file**, Run Code. +Logout, **Save File**, and Run Code. -**You must "Save File" after editing your code.** +**Click "Save File" after editing your code.** ### 6. How to start the FL client 6.1 FlowerHub -Go to Gfedops FlowerHub +Go to GFedOps FlowerHub. ![image.png](../../../img/FedOps-Launcher/image(7).png) -6.2 Select app you want to create +6.2 Select the app you want to create. ![image.png](../../../img/FedOps-Launcher/image(8).png) -6.3 Copy the command +6.3 Copy the command. ![image.png](../../../img/FedOps-Launcher/image(9).png) 6.4 CreateFL -Paste the command into the input box +Paste the command into the input box. -This will create the FL project in your directory. +This creates the FL project in your directory. ![image.png](../../../img/FedOps-Launcher/image(10).png) @@ -114,27 +112,67 @@ This installs the Python dependencies in your environment. ![image.png](../../../img/FedOps-Launcher/image(11).png) -6.6 Task +6.6 Server-side task and FL server setup -If you are logged in, you can choose a Task what you created on FedOps website. +Open the [FedOps Task Page](https://ccl.gachon.ac.kr/fedops/task). ![image.png](../../../img/FedOps-Launcher/image(12).png) +Sign in and create a Task on the FedOps website. + +![image.png](../../../img/FedOps-Launcher/image(13).png) + +Modify the task content as needed. First, enter a Task Title. + +You can also edit the Training Parameters. In this example, set **Clients Per Round** to `1` because only one client will be used. + +![image.png](../../../img/FedOps-Launcher/image(14).png) + +After reviewing the task settings, click the **Create** button to complete task creation. + +![image.png](../../../img/FedOps-Launcher/image(15).png) + +Create a dedicated Federated Learning server for your task by clicking the **Create Scalable Server** button. + +![image.png](../../../img/FedOps-Launcher/image(16).png) + +Click **Refresh Status** to check the current server status. + +![image.png](../../../img/FedOps-Launcher/image(17).png) + +{: .highlight } +💡 When the status shows **"FL Server created"**, you can proceed to the next step. + +Next, click the **Start FL Server** button to start the server. + +![image.png](../../../img/FedOps-Launcher/image(18).png) + +{: .highlight } +💡 To check the logs of the running server, enter `/app/data/logs/serverlog.txt` in the File Browser and click the **Load** button. + +![image.png](../../../img/FedOps-Launcher/image(19).png) + +When the server is fully prepared, proceed to the next step. + +6.7 Task + +If you are logged in, you can select a Task created on the FedOps website. + +![image.png](../../../img/FedOps-Launcher/image(20).png) + **In this example, "ssj" is the Task name. Select the Task created for your own environment.** Next, select the FL project to which you want to apply the Task. -![image.png](../../../img/FedOps-Launcher/image(13).png) - -**The selected Task must already be running on the FedOps website.** +![image.png](../../../img/FedOps-Launcher/image(21).png) **If the Task is not running on the FL server, FedOps Launcher cannot connect to the server.** -6.7 Run +6.8 Run -All settings are complete. Just click the **Run** button. +After completing all settings, click the **Run** button. -![image.png](../../../img/FedOps-Launcher/image(14).png) +![image.png](../../../img/FedOps-Launcher/image(22).png) ### 7. Stop FedOps Launcher @@ -146,4 +184,4 @@ docker rm -f fedops-launcher **Thank you.** -**You have successfully learned how to use the FedOps Launcher.** \ No newline at end of file +**You have successfully learned how to use the FedOps Launcher.** diff --git a/docs/img/FedOps-Launcher/image(12).png b/docs/img/FedOps-Launcher/image(12).png index ce6e4f725c..ef582ca73b 100644 Binary files a/docs/img/FedOps-Launcher/image(12).png and b/docs/img/FedOps-Launcher/image(12).png differ diff --git a/docs/img/FedOps-Launcher/image(13).png b/docs/img/FedOps-Launcher/image(13).png index 41a6ce2381..97afa14ff1 100644 Binary files a/docs/img/FedOps-Launcher/image(13).png and b/docs/img/FedOps-Launcher/image(13).png differ diff --git a/docs/img/FedOps-Launcher/image(14).png b/docs/img/FedOps-Launcher/image(14).png index 7c2d49123c..e2881ba42c 100644 Binary files a/docs/img/FedOps-Launcher/image(14).png and b/docs/img/FedOps-Launcher/image(14).png differ diff --git a/docs/img/FedOps-Launcher/image(15).png b/docs/img/FedOps-Launcher/image(15).png new file mode 100644 index 0000000000..be6dbe27bb Binary files /dev/null and b/docs/img/FedOps-Launcher/image(15).png differ diff --git a/docs/img/FedOps-Launcher/image(16).png b/docs/img/FedOps-Launcher/image(16).png new file mode 100644 index 0000000000..cff8bf6fa0 Binary files /dev/null and b/docs/img/FedOps-Launcher/image(16).png differ diff --git a/docs/img/FedOps-Launcher/image(17).png b/docs/img/FedOps-Launcher/image(17).png new file mode 100644 index 0000000000..7af8f41525 Binary files /dev/null and b/docs/img/FedOps-Launcher/image(17).png differ diff --git a/docs/img/FedOps-Launcher/image(18).png b/docs/img/FedOps-Launcher/image(18).png new file mode 100644 index 0000000000..8779697eae Binary files /dev/null and b/docs/img/FedOps-Launcher/image(18).png differ diff --git a/docs/img/FedOps-Launcher/image(19).png b/docs/img/FedOps-Launcher/image(19).png new file mode 100644 index 0000000000..54f5f32e14 Binary files /dev/null and b/docs/img/FedOps-Launcher/image(19).png differ diff --git a/docs/img/FedOps-Launcher/image(20).png b/docs/img/FedOps-Launcher/image(20).png new file mode 100644 index 0000000000..ce6e4f725c Binary files /dev/null and b/docs/img/FedOps-Launcher/image(20).png differ diff --git a/docs/img/FedOps-Launcher/image(21).png b/docs/img/FedOps-Launcher/image(21).png new file mode 100644 index 0000000000..41a6ce2381 Binary files /dev/null and b/docs/img/FedOps-Launcher/image(21).png differ diff --git a/docs/img/FedOps-Launcher/image(22).png b/docs/img/FedOps-Launcher/image(22).png new file mode 100644 index 0000000000..7c2d49123c Binary files /dev/null and b/docs/img/FedOps-Launcher/image(22).png differ