44Please make sure to finish the [ preparation steps] ( ../README.md ) before running the following steps.
55To run this example with NVFlare, follow the steps below or this [ notebook] ( ./xgboost_histogram_higgs.ipynb ) for an interactive experience.
66
7+ Note that we use "NVFlare as XGBoost Communicator" by default, for details please refer to
8+ [ NVFlare federated xgboost] ( https://nvflare.readthedocs.io/en/2.4/user_guide/federated_xgboost.html )
9+
710### Environment Preparation
811
912Switch to this directory and install additional requirements (suggest to do this inside virtual environment):
@@ -17,7 +20,7 @@ bash run_experiment_centralized.sh
1720```
1821
1922### Run federated experiments with simulator locally
20- Next, we will use the NVFlare simulator to run FL training automatically.
23+ Next, we will use the NVFlare simulator to run:
2124```
2225nvflare simulator jobs/higgs_2_histogram_v2_uniform_split_uniform_lr \
2326 -w /tmp/nvflare/xgboost_v2_workspace -n 2 -t 2
@@ -30,7 +33,7 @@ tensorboard --logdir /tmp/nvflare/xgboost_v2_workspace/simulate_job/tb_events
3033
3134## Timeout configuration
3235
33- Please refer to [ Reliable Federated XGBoost Timeout Mechanism] ( https://nvflare.readthedocs.io/en/2.4/user_guide/reliable_xgboost .html )
36+ Please refer to [ Federated XGBoost Timeout Mechanism] ( https://nvflare.readthedocs.io/en/2.4/user_guide/federated_xgboost/timeout .html )
3437
3538## Customization
3639
@@ -145,11 +148,15 @@ Each app is deployed to its own client site. Here is the `meta.json`,
145148 "min_clients": 4
146149 }
147150
148- ## Loose integration
151+ ## NVFlare as XGBoost Launcher
149152
150153We can use the NVFlare controller/executor just to launch the external xgboost
151154federated server and client.
152155
156+ For more information on the difference between "NVFlare as XGBoost Launcher"
157+ and "NVFlare as XGBoost Communicator" please refer to
158+ [ NVFlare federated xgboost] ( https://nvflare.readthedocs.io/en/2.4/user_guide/federated_xgboost.html )
159+
153160### Run federated experiments with simulator locally
154161Next, we will use the NVFlare simulator to run FL training automatically.
155162```
0 commit comments