refactor(examples): Update quickstart-xgboost app (#6288)

Co-authored-by: jafermarq <javier@flower.ai>

Author: mohammadnaseri

examples/docs/source/conf.py

@@ -76,6 +76,7 @@
     "pytorch-from-centralized-to-federated": "index.html",
     "flower-via-docker-compose": "index.html",
     "quickstart-sklearn-tabular": "quickstart-sklearn.html",
+    "xgboost-quickstart": "quickstart-xgboost.html",
 }
 
 

examples/xgboost-quickstart/README.md examples/quickstart-xgboost/README.mdexamples/xgboost-quickstart/README.md renamed to examples/quickstart-xgboost/README.md

@@ -32,7 +32,7 @@ This will create a new directory called `quickstart-xgboost` with the following
 
 ```shell
 quickstart-xgboost
-├── xgboost_quickstart
+├── quickstart_xgboost
 │   ├── __init__.py
 │   ├── client_app.py   # Defines your ClientApp
 │   ├── server_app.py   # Defines your ServerApp
@@ -43,7 +43,7 @@ quickstart-xgboost
 
 ### Install dependencies and project
 
-Install the dependencies defined in `pyproject.toml` as well as the `xgboost_quickstart` package.
+Install the dependencies defined in `pyproject.toml` as well as the `quickstart_xgboost` package.
 
 ```bash
 pip install -e .

…amples/xgboost-quickstart/pyproject.toml …amples/quickstart-xgboost/pyproject.tomlexamples/xgboost-quickstart/pyproject.toml renamed to examples/quickstart-xgboost/pyproject.toml examples/xgboost-quickstart/pyproject.toml renamed to examples/quickstart-xgboost/pyproject.toml

@@ -20,8 +20,8 @@ packages = ["."]
 publisher = "flwrlabs"
 
 [tool.flwr.app.components]
-serverapp = "xgboost_quickstart.server_app:app"
-clientapp = "xgboost_quickstart.client_app:app"
+serverapp = "quickstart_xgboost.server_app:app"
+clientapp = "quickstart_xgboost.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = 3
@@ -44,3 +44,7 @@ default = "local-simulation"
 
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 20
+
+[tool.flwr.federations.supergrid-deployment]
+address = "supergrid.flower.ai"
+enable-account-auth = true

examples/quickstart-xgboost/quickstart_xgboost/__init__.py

@@ -0,0 +1 @@
+"""quickstart-xgboost: A Flower / XGBoost app."""

…ckstart/xgboost_quickstart/client_app.py …xgboost/quickstart_xgboost/client_app.pyexamples/xgboost-quickstart/xgboost_quickstart/client_app.py renamed to examples/quickstart-xgboost/quickstart_xgboost/client_app.py examples/xgboost-quickstart/xgboost_quickstart/client_app.py renamed to examples/quickstart-xgboost/quickstart_xgboost/client_app.py

@@ -1,4 +1,4 @@
-"""xgboost_quickstart: A Flower / XGBoost app."""
+"""quickstart-xgboost: A Flower / XGBoost app."""
 
 import warnings
 
@@ -8,7 +8,7 @@
 from flwr.clientapp import ClientApp
 from flwr.common.config import unflatten_dict
 
-from xgboost_quickstart.task import load_data, replace_keys
+from quickstart_xgboost.task import load_data, replace_keys
 
 warnings.filterwarnings("ignore", category=UserWarning)
 

…ckstart/xgboost_quickstart/server_app.py …xgboost/quickstart_xgboost/server_app.pyexamples/xgboost-quickstart/xgboost_quickstart/server_app.py renamed to examples/quickstart-xgboost/quickstart_xgboost/server_app.py examples/xgboost-quickstart/xgboost_quickstart/server_app.py renamed to examples/quickstart-xgboost/quickstart_xgboost/server_app.py

@@ -1,4 +1,4 @@
-"""xgboost_quickstart: A Flower / XGBoost app."""
+"""quickstart_xgboost: A Flower / XGBoost app."""
 
 import numpy as np
 import xgboost as xgb
@@ -7,7 +7,7 @@
 from flwr.serverapp import Grid, ServerApp
 from flwr.serverapp.strategy import FedXgbBagging
 
-from xgboost_quickstart.task import replace_keys
+from quickstart_xgboost.task import replace_keys
 
 # Create ServerApp
 app = ServerApp()

…st-quickstart/xgboost_quickstart/task.py …start-xgboost/quickstart_xgboost/task.pyexamples/xgboost-quickstart/xgboost_quickstart/task.py renamed to examples/quickstart-xgboost/quickstart_xgboost/task.py examples/xgboost-quickstart/xgboost_quickstart/task.py renamed to examples/quickstart-xgboost/quickstart_xgboost/task.py

@@ -1,4 +1,4 @@
-"""xgboost_quickstart: A Flower / XGBoost app."""
+"""quickstart_xgboost: A Flower / XGBoost app."""
 
 import xgboost as xgb
 from flwr_datasets import FederatedDataset