From f5ac81f01caa80091f531ec627948e537a9a9e50 Mon Sep 17 00:00:00 2001 From: Marcelo Lotif Date: Fri, 22 Mar 2024 12:29:20 -0400 Subject: [PATCH] Small documentation updates (#14) --- CONTRIBUTING.md | 2 +- docs/source/index.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e370c03..a4ddbbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to AI Engineering Projects +# Contributing to FLorist Thanks for your interest in contributing! diff --git a/docs/source/index.md b/docs/source/index.md index 4822dff..2a7b7ce 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -18,13 +18,13 @@ by providing a system to easily kick off, orchestrate, manage, collect, and summ of [FL4Health](https://github.com/VectorInstitute/FL4Health) training jobs. As Federated Learning has a client and a server side, FLorist also has client and server-side -“modes” to orchestrate the training process on both sides. FLorist will have long-running -processes on the clients, which will be waiting for instructions from the FLorist server to -start training. Once the FL server is started, FLorist will monitor both server and client -processes as well as its own FL server process while collecting their progress to be displayed -in a web UI for monitoring. +“modes” to orchestrate the training process on both sides. When FLorist's client long-running +process is started, they will be waiting for instructions from FLorist's server to start +FL clients for training. Once FLorist's server starts the FL server, it sends instructions +to FLorist's clients to start their own FL clients. Then, FLorist's server monitors the FL server +and clients processes while collecting their progress to be displayed in the web UI. -At the end of training, it will save the results in a database and also provide access to the +At the end of training, it saves the results in a database and also provide access to the training artifacts (e.g. model files). For a visual representation of the system, please check the diagram below.