Skip to content

Commit

Permalink
Update outdated links (#2368)
Browse files Browse the repository at this point in the history
  • Loading branch information
YuanTingHsieh authored Feb 20, 2024
1 parent eaa4687 commit 3460970
Show file tree
Hide file tree
Showing 10 changed files with 9 additions and 14 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/markdown-links-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ name: Check Markdown links

on:
push:
branches: [ "main", "dev" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "main", "dev" ]

jobs:
markdown-link-check:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/premerge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ name: pre-merge
on:
# quick tests for pull requests and the releasing branches
push:
branches:
- dev
pull_request:
workflow_dispatch:

Expand Down
2 changes: 1 addition & 1 deletion examples/advanced/cifar10/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Please make sure you set up virtual environment and follows [example root readme
This example includes instructions on running [FedAvg](https://arxiv.org/abs/1602.05629),
[FedProx](https://arxiv.org/abs/1812.06127), [FedOpt](https://arxiv.org/abs/2003.00295),
and [SCAFFOLD](https://arxiv.org/abs/1910.06378) algorithms using NVFlare's
[FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html).
[FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html).

### [Real-world Federated Learning with CIFAR-10](./cifar10-real-world/README.md)
Real-world FL deployment requires secure provisioning and the admin API to submit jobs.
Expand Down
2 changes: 1 addition & 1 deletion examples/advanced/cifar10/cifar10-sim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To speed up the following experiments, first download the [CIFAR-10](https://www

## 3. Run simulated FL experiments

We are using NVFlare's [FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html) to run the following experiments.
We are using NVFlare's [FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html) to run the following experiments.

The output root of where to save the results is set in [./run_simulator.sh](./run_simulator.sh) as `RESULT_ROOT=/tmp/nvflare/sim_cifar10`.

Expand Down
2 changes: 1 addition & 1 deletion examples/advanced/nlp-ner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Let's take a closer look at the word-label correspondence:
As shown above, the task is to capture the keywords related to medical findings.

## Run automated experiments
We use the NVFlare [simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html) to run the FL training.
We use the NVFlare [simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html) to run the FL training.
Set `PYTHONPATH` to include custom files of this example:
```
export PYTHONPATH=${PWD}
Expand Down
2 changes: 1 addition & 1 deletion examples/advanced/sklearn-kmeans/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Below is a sample config for site-1, saved to `./jobs/sklearn_kmeans_3_uniform/a
```

## Run experiment with FL simulator
The [FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html) simulates FL experiments or debugging codes,
The [FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html) simulates FL experiments or debugging codes,
not for real-world FL deployment.
We can run the FL simulator with 3 clients under the uniform data split with
```commandline
Expand Down
2 changes: 1 addition & 1 deletion examples/advanced/sklearn-linear/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Below is a sample config for site-1, saved to `./jobs/sklearn_linear_5_uniform/a
```

## Run experiment with FL simulator
[FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html) is used to simulate FL experiments or debug codes, not for real FL deployment.
[FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html) is used to simulate FL experiments or debug codes, not for real FL deployment.
We can run the FL simulator with five clients under the uniform data split with
```commandline
bash run_experiment_simulator.sh
Expand Down
4 changes: 2 additions & 2 deletions examples/advanced/sklearn-svm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Under this setting, federated learning can be formulated in two steps:

Unlike other iterative federated algorithms, federated SVM only involves
these two training steps. Hence, in the server config, we have
```json
```
"num_rounds": 2
```
The first round is the training round, performing local training and global aggregation.
Expand Down Expand Up @@ -116,7 +116,7 @@ Below is a sample config for site-1, saved to `./jobs/sklearn_svm_3_uniform/app_
```

## Run experiment with FL simulator
[FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html) is used to simulate FL experiments or debug codes, not for real FL deployment.
[FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html) is used to simulate FL experiments or debug codes, not for real FL deployment.
We can run the FL simulator with three clients under the uniform data split with
```commandline
bash run_experiment_simulator.sh
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Split Learning with CIFAR-10

This example includes instructions on how to run [split learning](https://arxiv.org/abs/1810.06060) (SL) using the
CIFAR-10 dataset and the [FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/fl_simulator.html).
CIFAR-10 dataset and the [FL simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html).

We assume one client holds the images, and the other client holds the labels to compute losses and accuracy metrics.
Activations and corresponding gradients are being exchanged between the clients using NVFlare.
Expand Down
2 changes: 1 addition & 1 deletion examples/tutorials/flare_simulator.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"## Intro to the FL Simulator\n",
"\n",
"The [FL Simulator](https://nvflare.readthedocs.io/en/main/user_guide/fl_simulator.html) runs a local simulation of a running NVFLARE FL deployment. This allows researchers to test and debug an application without provisioning a real, distributed FL project. The FL Simulator runs a server and multiple clients in the same local process, with communication that mimics a real deployment. This allows researchers to more quickly build out new components and jobs that can be directly used in a production deployment.\n",
"The [FL Simulator](https://nvflare.readthedocs.io/en/latest/user_guide/nvflare_cli/fl_simulator.html) runs a local simulation of a running NVFLARE FL deployment. This allows researchers to test and debug an application without provisioning a real, distributed FL project. The FL Simulator runs a server and multiple clients in the same local process, with communication that mimics a real deployment. This allows researchers to more quickly build out new components and jobs that can be directly used in a production deployment.\n",
"\n",
"### Setup\n",
"The NVFlare [Getting Started Guide](https://nvflare.readthedocs.io/en/main/getting_started.html) provides instructions for setting up FLARE on a local system or in a Docker image. We've also cloned the NVFlare GitHub in our top-level working directory."
Expand Down

0 comments on commit 3460970

Please sign in to comment.