Skip to content

Commit 1421b1a

Browse files
committed
Updated links in Outline for Sec 3
1 parent 07b9729 commit 1421b1a

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ This workshop will be mainly organised in **two parts**. In the first part, we w
3030
- Model _Inference attack_ with `OPACUS` notebooks: [training](2-mia-differential-privacy/4-MIA-Training-OPACUS.ipynb) | [reconstruction](2-mia-differential-privacy/5-MIA-Reconstruction-OPACUS.ipynb)
3131

3232
- **Part 2**: Primer on Privacy-Preserving Machine Learning
33-
- Introduction to Federated Learning [notebook](./3-federated-learning/1%20Intro%20to%20Federated%20Learning.ipynb)
34-
- DL training on (Homomorphically) Encrypted Data [notebook](./3-federated-learning/2%20Homomorphic%20Encryption.ipynb)
35-
- OpenMined and PrivateAI series [notebook](./3-federated-learning/3%20OpenMined%20Private%20AI%20Series.ipynb)
33+
- Introduction to Federated Learning [notebook](./3-federated-learning/1-Intro-Federated-Learning.ipynb)
34+
- DL training on (Homomorphically) Encrypted Data [notebook](./3-federated-learning/2-Homomorphic-Encryption.ipynb)
35+
- OpenMined and PrivateAI series [notebook](./3-federated-learning/3-OpenMined-private-AI-series.ipynb)
3636
- Introduction to Remote Data Science [notebooks](./3-federated-learning/duet_iris_classifier/)
3737
- SplitNN [notebooks](./3-federated-learning/duet_splitnn/)
3838

3939
## Get the material
4040

41-
Clone the current repository, in order to get the course materials. To do so, once connected to your remote machine (via `SSH`), execute the following instructions:
41+
Clone the current repository by running the following instructions:
4242

4343
```bash
4444
cd $HOME # This will make sure you'll be in your HOME folder
@@ -51,24 +51,27 @@ git clone https://github.com/leriomaggio/ppml-tutorial.git
5151
cd ppml-tutorial
5252
```
5353

54-
Well done! Now you should do be in the right location. Bear with me another few seconds, following instructions reported below 🙏
54+
Well done! Now you should do be in the right location.
55+
Bear with me for another few seconds, following instructions reported below 🙏
5556

5657
### Set up your Environment
5758

5859
There are indeed two (possibly _three_) methods that you could use to execute the code in the notebooks.
5960

6061
The **recommended** method is to setup a new `ppml` Python environment on your local machine.
6162

62-
Please refer to the [`setup.md`](./setup.md) document for a step-by-step guide on how to setup the environment, and check that all is working.
63+
Please refer to the [`setup.md`](./setup.md) document for a step-by-step guide on how to set up the environment, and to check that all is working.
6364

64-
**Alternartively** you could rely on services such as [MyBinder](https://mybinder.org) or [Google Colab](https://colab.research.google.com) to run the notebooks interactively, and without needing to setup your Python environment locally.
65+
**Alternartively** you could rely on services such as [MyBinder](https://mybinder.org) or [Google Colab](https://colab.research.google.com) to run the notebooks interactively, and without needing to install anything.
6566

6667
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/leriomaggio/ppml-tutorial/HEAD) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/leriomaggio/ppml-tutorial/blob/main/index.ipynb)
6768

6869
However, these alternative solutions come with some **caveats and workarounds** that should be considered:
6970

70-
1. MyBinder does not support connection to remote hosts on (not-allowed ports). Therefore, the entire Section 3 on Federated Learning and `syft` does not work.
71-
2. To use Google Colab it is necessary to have a **Google Account**. Plus, the environment cannot be setup automatically (notebooks contain additional instructions to do so, in case)
71+
1. MyBinder does not support connection to remote hosts on (not-allowed) network ports. This means that all the examples in Sec. 3 running `syft` and `duet` will **never** work.
72+
- I would recommend running those notebooks in `Colab` in case.
73+
2. To use Google Colab it is necessary to have a **Google Account**. Plus, the environment cannot be setup automatically so sometimes additional deps and packages should be installed first
74+
- On this note, please consider that notebooks requiring additional dependencies contain instructions to do so, in their preamble section.
7275

7376
## Colophon
7477

0 commit comments

Comments
 (0)