Skip to content

Commit

Permalink
Update studio.rst (#633)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jxlle authored Jun 12, 2024
1 parent bf45963 commit a0ba7d8
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/studio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Studio

FEDn Studio is a web-based tool for managing and monitoring federated learning experiments. It provides the FEDn network as a managed service, as well as a user-friendly interface for monitoring the progress of training and visualizing the results. FEDn Studio is available as a SaaS at `fedn.scaleoutsystems.com <https://fedn.scaleoutsystems.com>`_ . It is free for development, testing and research (one project per user, backend compute resources sized for dev/test).

Scaleout can also support users to scale up experiments and demonstrators on Studio, by granting custom resource quotas. Additonally, charts are available for self-managed deployment on-premise or in your cloud VPC (all major cloud providers). Contact the Scaleout team for more information.
Scaleout can also support users to scale up experiments and demonstrators on Studio, by granting custom resource quotas. Additionally, charts are available for self-managed deployment on-premise or in your cloud VPC (all major cloud providers). Contact the Scaleout team for more information.

Getting started
---------------
Expand All @@ -29,7 +29,7 @@ Once you have created a project, you can find it via the sidebar link Projects.
2. **Clients**: management of client configurations and a list of current clients. Observe that this feature does not deploy clients, instead it configures a client config that contains a unique token which is required to connect to the reducer and the combiner.
3. **Combiners**: a list of combiners. Observe number of active clients for each combiner.
4. **Sessions**: a list of sessions with related models. Configure and start a new session. Upload compute package and seed model, set number of rounds, timeout limit etc.
5. **Models**: a list of models generated across sessions, and dahsboards for visualizing training progress.
5. **Models**: a list of models generated across sessions, and dashboards for visualizing training progress.
6. **Events**: a log of events from the combiner and the clients of the federated network.
7. **Settings**: project settings, including the option to give access to other users and to delete the project.

Expand All @@ -46,7 +46,7 @@ Please see :ref:`package-creation` for instructions on how to create a package a
Upload files
------------

In the Studio UI, navigate to the project you created and click on the "Sessions" tab. Click on the "New Session" button. Under the Compute package tab, select a name and upload the generated package file. Under the Seed model tab upload the generated seed file:
In the Studio UI, navigate to the project you created and click on the "Sessions" tab. Click on the "New Session" button. Under the "Compute package" tab, select a name and upload the generated package file. Under the "Seed model" tab, upload the generated seed file:

.. image:: img/upload_package.png

Expand All @@ -69,12 +69,12 @@ If the client is successfully connected, you should see the client listed in the
Start a training session
------------------------

In Studio click on the "Sessions" link, then the "New session" button in the upper right corner. Click the Start session tab and enter your desirable settings (or use default) and hit the "Start run" button. In the terminal where your are running your client you should now see some activity. When the round is completed you can see the results in the FEDn Studio UI on the "Models" page.
In Studio click on the "Sessions" link, then the "New session" button in the upper right corner. Click the "Start session" tab and enter your desirable settings (or use default) and hit the "Start run" button. In the terminal where your are running your client you should now see some activity. When the round is completed, you can see the results in the FEDn Studio UI on the "Models" page.

Watch the training progress
---------------------------

Once a training session is started, you can monitor the progress of the training by navigating to "Sessions" and click on the "Open" button of the active session. The session page will list the models as soon as they are generated. To get more information about a particular model, navigate to the model page by clicking the model name. From the model page you can download the model wieghts and get validation metrics.
Once a training session is started, you can monitor the progress of the training by navigating to "Sessions" and click on the "Open" button of the active session. The session page will list the models as soon as they are generated. To get more information about a particular model, navigate to the model page by clicking the model name. From the model page you can download the model weights and get validation metrics.

To get an overview of how the models have evolved over time, navigate to the "Models" tab in the sidebar. Here you can see a list of all models generated across sessions along with a graph showing some metrics of how the models are performing.

Expand All @@ -86,5 +86,5 @@ Accessing the API
-----------------

The FEDn Studio API is available at <controller-host>/api/v1/. The controller host can be found in the project dashboard. Further, to access the API you need an admin API token.
Nevigate to the "Settings" tab in the project and click on the "Generate token" button. Copy the token and use it to access the API. Please see :py:mod:`fedn.network.api` for how to pass the token to the APIClient.
Navigate to the "Settings" tab in the project and click on the "Generate token" button. Copy the token and use it to access the API. Please see :py:mod:`fedn.network.api` for how to pass the token to the APIClient.

0 comments on commit a0ba7d8

Please sign in to comment.