📝 FedOps Launcher Guide


This guide provides step-by-step instructions for using FedOps Launcher, a FedOps-based client execution environment.

Step-by-Step Guide

1. Install Docker

image.png

Docker Install Address: https://www.docker.com/get-started/

Windows users should run Docker in a WSL environment, because Docker is generally more stable in Unix-based environments such as macOS and Linux.

2. Run the command in a CLI environment

2.1 Default command

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"

image.png

In my case, I use VS Code in a Windows WSL environment. Just copy the command and run it in your CLI environment.

2.2 If you want to use your GPU (Optional)

docker rm -f fedops-launcher 2>/dev/null; docker run -d --name fedops-launcher --gpus all -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"

If your environment does not have an NVIDIA GPU, an error will occur.

3. Open your browser and connect to FedOps Launcher

3.1 Open your browser and enter http://127.0.0.1:5600 in the address bar

image.png

3.2 You can also open the website directly by clicking the address shown in the CLI

image.png

4. Log in

image.png

4.1 Use the same ID and password that you use on the FedOps website

4.2 You can also continue in Guest mode

In Guest mode, you cannot load the Task information you created on the FedOps website.

5. Main functions of FedOps Launcher

This is the main screen of the FedOps client.

image.png

5.1 Start the FL client with these buttons

5.2 Manage the file system inside the container

5.3 View logs and execute commands in the terminal

5.4 Edit code

5.5 Extra button

Logout, Save file, Run Code. You must “Save File” after editing your code.

6. How to start the FL client

6.1 FlowerHub

Go to Gfedops FlowerHub

image.png

6.2 Select app you want to create

image.png

6.2 Copy the command

image.png

6.3 CreateFL - Paste the command into the input box

This will create the FL project in your directory.

image.png

6.4 Install

This installs the Python dependencies in your environment.

image.png

6.5 Task

If you are logged in, you can choose a Task that you created on the FedOps website.

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

The selected Task must already be running on the FedOps website. If the Task is not running on the FL server, FedOps Launcher cannot connect to the server.

6.6 Run

All settings are complete. Just click the Run button.

image.png

Thank you.

You have successfully started the FedOps Launcher.