From 13019a92e28d2d211b9a64c5261c08ddc0302608 Mon Sep 17 00:00:00 2001 From: sztoor Date: Fri, 30 Aug 2024 09:16:28 +0200 Subject: [PATCH] Docs/SK-957 | Update example notebooks with fedn Changes to be committed: modified: examples/notebooks/API_Example.ipynb modified: examples/notebooks/Aggregators.ipynb Update example notebooks with fedn studio endpoints --- examples/notebooks/API_Example.ipynb | 2 +- examples/notebooks/Aggregators.ipynb | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/examples/notebooks/API_Example.ipynb b/examples/notebooks/API_Example.ipynb index 6bbc9b8a8..79e3501c6 100644 --- a/examples/notebooks/API_Example.ipynb +++ b/examples/notebooks/API_Example.ipynb @@ -35,7 +35,7 @@ "source": [ "We connect to the FEDn API service. In this example, we assume the project is hosted on the public FEDn Studio. You can find the CONTROLLER_HOST address in the project dashboard. \n", "\n", - "NOTE: If you're using a local sandbox, the CONTROLLER_HOST will be \"localhost,\" and the CONTROLLER_PORT will be 8092.\n", + "NOTE: If you're using a local sandbox, the CONTROLLER_HOST will be \"localhost or 127.0.0.1 or your local node's IP address\" and the CONTROLLER_PORT will be 8092. \n", "\n", "Next, you'll need to generate an access token. To do this, go to the project page in FEDn Studio, click on \"Settings,\" then \"Generate token.\" Copy the access token from the Studio and paste it into the notebook. In case you need further details, have a look at the [Fedn ClientAPIs](https://fedn.readthedocs.io/en/latest/apiclient.html#). " ] diff --git a/examples/notebooks/Aggregators.ipynb b/examples/notebooks/Aggregators.ipynb index 83b77d082..265e2cdf7 100644 --- a/examples/notebooks/Aggregators.ipynb +++ b/examples/notebooks/Aggregators.ipynb @@ -9,7 +9,9 @@ "\n", "This notebook shows how to use different Aggregators (FedAvg, FedAdam, FedYogi, FedAdaGrad). \n", "\n", - "For a complete list of implemented interfaces, please refer to the [FEDn APIs](https://fedn.readthedocs.io/en/latest/fedn.network.api.html#module-fedn.network.api.client).\n", + "For a complete list of implemented interfaces, please refer to the [FEDn APIs](https://fedn.readthedocs.io/en/latest/fedn.network.api.html#module-fedn.network.api.client). \n", + "\n", + "For implementation details related to how aggregators are implemented, we recommend to read [FEDn Framework Extensions](https://www.scaleoutsystems.com/post/fedn-framework-extensions).\n", "\n", "Before starting this tutorial, make sure you have a project running in FEDn Studio and have created the compute package and the initial model. If you're not sure how to do this, please follow the instructions in sections 1, 2, and 3 of the [quickstart guide](https://fedn.readthedocs.io/en/latest/quickstart.html).\n", " \n",