Skip to content

Commit 06514a4

Browse files
Update doc link (#2482)
1 parent 40cff16 commit 06514a4

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

examples/advanced/finance/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ For more details, please refer to the READMEs for
1818
and [tree-based](https://github.com/NVIDIA/NVFlare/tree/main/examples/advanced/xgboost/tree-based/README.md)
1919
methods.
2020

21+
For histogram-based collaboration we use "NVFlare as XGBoost Communicator" by default,
22+
for details please refer to [NVFlare federated xgboost](https://nvflare.readthedocs.io/en/2.4/user_guide/federated_xgboost.html)
23+
24+
2125
## Data Preparation
2226
### Download and Store Data
2327
To run the examples, we first download the dataset from the link above, which is a single `.csv` file.

examples/advanced/vertical_xgboost/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
This example shows how to use vertical federated learning with [NVIDIA FLARE](https://nvflare.readthedocs.io/en/main/index.html) on tabular data.
33
Here we use the optimized gradient boosting library [XGBoost](https://github.com/dmlc/xgboost) and leverage its federated learning support.
44

5+
Note that we use "NVFlare as XGBoost Communicator" by default, for details please refer to
6+
[NVFlare federated xgboost](https://nvflare.readthedocs.io/en/2.4/user_guide/federated_xgboost.html)
7+
8+
59
Before starting please make sure you set up a [virtual environment](../../README.md#set-up-a-virtual-environment) and install the additional requirements:
610
```
711
python3 -m pip install -r requirements.txt

examples/advanced/xgboost/histogram-based/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Please make sure to finish the [preparation steps](../README.md) before running the following steps.
55
To 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

912
Switch 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
```
2225
nvflare 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

150153
We can use the NVFlare controller/executor just to launch the external xgboost
151154
federated 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
154161
Next, we will use the NVFlare simulator to run FL training automatically.
155162
```

0 commit comments

Comments
 (0)