Skip to content

Commit 85a5934

Browse files
committed
README feedback updates
1 parent a167eee commit 85a5934

21 files changed

+50
-18
lines changed

LICENSE

+7-7
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,10 @@
204204
The following files are copied from CPython and are under the PSF license.
205205
See here for more: https://github.com/python/cpython/blob/master/LICENSE
206206

207-
tests/syft/lib/python/collections/ordered_dict/ordered_dict_sanity_test.py
208-
tests/syft/lib/python/complex/complex_test.py
209-
tests/syft/lib/python/dict/dict_test.py
210-
tests/syft/lib/python/float/float_test.py
211-
tests/syft/lib/python/list/list_test.py
212-
tests/syft/lib/python/string/string_utils_test.py
213-
tests/syft/lib/python/range/range_test.py
207+
packages/syft/tests/syft/lib/python/collections/ordered_dict/ordered_dict_sanity_test.py
208+
packages/syft/tests/syft/lib/python/complex/complex_test.py
209+
packages/syft/tests/syft/lib/python/dict/dict_test.py
210+
packages/syft/tests/syft/lib/python/float/float_test.py
211+
packages/syft/tests/syft/lib/python/list/list_test.py
212+
packages/syft/tests/syft/lib/python/string/string_utils_test.py
213+
packages/syft/tests/syft/lib/python/range/range_test.py

README.md

+43-11
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<img src="packages/syft/docs/img/title_syft_light.png#gh-light-mode-only" alt="Syft Logo" width="200px" />
77
<img src="packages/syft/docs/img/title_syft_dark.png#gh-dark-mode-only" alt="Syft Logo" width="200px" />
88

9-
Remote Data Science - Code for `computing on data`, you `do not own` and `cannot see`
9+
Perform `numpy`-like analysis on `data` that remains in `someone else's` server
1010

1111
<div align="left">
1212
<img src="packages/syft/docs/img/header.png#gh-light-mode-only" alt="Syft Overview" width="100%" />
@@ -24,7 +24,7 @@ Remote Data Science - Code for `computing on data`, you `do not own` and `cannot
2424
💻 `hagrid quickstart`
2525
2626
- In the tutorial you will learn how to install and deploy:
27-
`PySyft` = our `torch`-like 🐍 Python Library
27+
`PySyft` = our `numpy`-like 🐍 Python Library
2828
`PyGrid` = our 🐳 `docker` / `k8s` Data Platform
2929
3030
- During quickstart we will deploy `PyGrid` to localhost with 🐳 `docker`, however 🛵 HAGrid can deploy to `k8s` or a 🐧 `ubuntu` VM on `azure` / `gcp` / `ANY_IP_ADDRESS` by using 🔨 `ansible`†
@@ -36,9 +36,9 @@ Remote Data Science - Code for `computing on data`, you `do not own` and `cannot
3636

3737
`Linux``macOS`\*`Windows`†‡
3838

39-
- `HAGrid` = our our handy 🛵 cli tool
40-
- `PySyft` = our `torch`-like 🐍 Python Library
41-
- `PyGrid` = our 🐳 `docker` / `k8s` Data Platform
39+
- `PySyft` = our `numpy`-like 🐍 Python library for computing on `private data` in someone else's `Domain` server
40+
- `PyGrid` = our 🐳 `docker` / `k8s` / 🐧 `vm` `Domain` & `Network` Servers where `private data` lives
41+
- `HAGrid` = our our handy 🛵 cli tool which makes `deploying` a `Domain` or `Network` server a one-liner
4242

4343
3. Read our 📚 <a href="https://openmined.github.io/PySyft/">Docs</a>
4444
4. Ask Questions ❔ in `#support` on <a href="https://slack.openmined.org/">Slack</a>
@@ -64,7 +64,8 @@ Remote Data Science - Code for `computing on data`, you `do not own` and `cannot
6464
PySyft and PyGrid use the same `version` and its best to match them up where possible. We release weekly betas which can be used in each context:
6565
PySyft: `pip install syft --pre`
6666
PyGrid: `hagrid launch ... tag=latest`
67-
Quickstart: `hagrid quickstart --pre`
67+
68+
<!-- Quickstart: `hagrid quickstart --pre` -->
6869

6970
HAGrid is a cli / deployment tool so the latest version of `hagrid` is usually the best.
7071

@@ -74,11 +75,11 @@ HAGrid is a cli / deployment tool so the latest version of `hagrid` is usually t
7475

7576
<img align="right" src="packages/syft/docs/img/logo_big_dark.png#gh-dark-mode-only" alt="Syft" height="250" style="padding-left:30px;">
7677

77-
`Syft` is OpenMined's `open source` stack that provides `secure` and `private` Data Science in Python. Syft decouples `private data` from model training, using techniques like [Federated Learning](https://ai.googleblog.com/2017/04/federated-learning-collaborative.html), [Differential Privacy](https://en.wikipedia.org/wiki/Differential_privacy), and [Encrypted Computation](https://en.wikipedia.org/wiki/Homomorphic_encryption). This is done with a `torch`-like interface and integration with `Deep Learning` frameworks so that you as a `Data Scientist` can maintain your current workflow while using these new `privacy-enhancing techniques`.
78+
`Syft` is OpenMined's `open source` stack that provides `secure` and `private` Data Science in Python. Syft decouples `private data` from model training, using techniques like [Federated Learning](https://ai.googleblog.com/2017/04/federated-learning-collaborative.html), [Differential Privacy](https://en.wikipedia.org/wiki/Differential_privacy), and [Encrypted Computation](https://en.wikipedia.org/wiki/Homomorphic_encryption). This is done with a `numpy`-like interface and integration with `Deep Learning` frameworks, so that you as a `Data Scientist` can maintain your current workflow while using these new `privacy-enhancing techniques`.
7879

7980
### Why should I use Syft?
8081

81-
`Syft` allows a `Data Scientist` to ask `questions` about a `dataset` and, within `privacy limits` set by the `data owner`, get `answers` to those `questions`, all without obtaining a `copy` of the data itself. We call this process `Remote Data Science`. It means in a wide variety of `domains` across society, the current `risks` of sharing information (`copying` data) with someone such as, privacy invasion, IP theft and blackmail will no longer prevent the ability to utilize the vast `benefits` such as innovation, insights and scientific discovery.
82+
`Syft` allows a `Data Scientist` to ask `questions` about a `dataset` and, within `privacy limits` set by the `data owner`, get `answers` to those `questions`, all without obtaining a `copy` of the data itself. We call this process `Remote Data Science`. It means in a wide variety of `domains` across society, the current `risks` of sharing information (`copying` data) with someone such as, privacy invasion, IP theft and blackmail will no longer prevent the vast `benefits` such as innovation, insights and scientific discovery which secure access will provide.
8283

8384
No more cold calls to get `access` to a dataset. No more weeks of `wait times` to get a `result` on your `query`. It also means `1000x more data` in every domain. PySyft opens the doors to a streamlined Data Scientist `workflow`, all with the individual's `privacy` at its heart.
8485

@@ -222,7 +223,7 @@ Provides services to a group of `Data Owners` and `Data Scientists`, such as dat
222223
🎥 <a href="https://www.youtube.com/watch?v=Pr4erdusiW0">Privacy-Preserving Data Science - TWiML Talk #241</a><br />
223224
🎥 <a href="https://www.youtube.com/watch?v=NJBBE_SN90A">Privacy Preserving AI - PyTorch Devcon 2019</a><br />
224225
📖 <a href="https://arxiv.org/pdf/2110.01315.pdf">Towards general-purpose infrastructure for protecting ...</a><br />
225-
📖 <a href="https://arxiv.org/pdf/2104.12385.pdf">Syft 0.5: A platform for universally deployable structured ...</a><br />
226+
📖 <a href="https://arxiv.org/pdf/2104.12385.pdf">Syft 0.5: A platform for universally deployable ...</a><br />
226227
📖 <a href="https://arxiv.org/pdf/1811.04017.pdf">A generic framework for privacy preserving deep learning</a>
227228
</sup></sup></p>
228229
</div>
@@ -272,8 +273,39 @@ OpenMined and Syft appreciates all contributors, if you would like to fix a bug
272273

273274
# Supporters
274275

275-
<img src="packages/syft/docs/img/logos_light.png#gh-light-mode-only" alt="Supporters" width="100%" />
276-
<img src="packages/syft/docs/img/logos_dark.png#gh-dark-mode-only" alt="Supporters" width="100%" />
276+
<table border="0">
277+
<tr>
278+
<th align="center">
279+
<a href="https://sloan.org/"><img src="packages/syft/docs/img/logo_sloan.png" /></a>
280+
</th>
281+
<th align="center">
282+
<a href="https://opensource.fb.com/"><img src="packages/syft/docs/img/logo_meta.png" /></a>
283+
</th>
284+
<th align="center">
285+
<a href="https://pytorch.org/"><img src="packages/syft/docs/img/logo_torch.png" /></a>
286+
</th>
287+
<th align="center">
288+
<a href="https://www.udacity.com/"><img src="packages/syft/docs/img/logo_udacity.png" /></a>
289+
</th>
290+
<th align="center">
291+
<a href="https://summerofcode.withgoogle.com/"><img src="packages/syft/docs/img/logo_gsoc.png" /></a>
292+
</th>
293+
<th align="center">
294+
<a href="https://developers.google.com/season-of-docs"><img src="packages/syft/docs/img/logo_gsod.png" /></a>
295+
</th>
296+
<th align="center">
297+
<img src="packages/syft/docs/img/logo_arkhn_light.png#gh-light-mode-only" />
298+
<img src="packages/syft/docs/img/logo_arkhn.png#gh-dark-mode-only" />
299+
</th>
300+
<th align="center">
301+
<img src="packages/syft/docs/img/logo_cape_light.png#gh-light-mode-only" />
302+
<img src="packages/syft/docs/img/logo_cape.png#gh-dark-mode-only" />
303+
</th>
304+
<th align="center">
305+
<a href="https://begin.ai/"><img src="packages/syft/docs/img/logo_begin.png" /></a>
306+
</th>
307+
</tr>
308+
</table>
277309

278310
# Open Collective
279311

packages/syft/docs/img/header.png

1.45 KB
Loading

packages/syft/docs/img/logo.png

130 KB
Loading

packages/syft/docs/img/logo_arkhn.png

5.2 KB
Loading
6.49 KB
Loading

packages/syft/docs/img/logo_begin.png

6.25 KB
Loading

packages/syft/docs/img/logo_big.png

141 KB
Loading
134 KB
Loading

packages/syft/docs/img/logo_cape.png

3.05 KB
Loading
2.79 KB
Loading

packages/syft/docs/img/logo_gsoc.png

6.09 KB
Loading

packages/syft/docs/img/logo_gsod.png

10.3 KB
Loading

packages/syft/docs/img/logo_meta.png

10.6 KB
Loading

packages/syft/docs/img/logo_sloan.png

14.2 KB
Loading

packages/syft/docs/img/logo_torch.png

3.62 KB
Loading
3.44 KB
Loading

packages/syft/docs/img/logos_dark.png

-61.6 KB
Binary file not shown.
-64.8 KB
Binary file not shown.
-2.74 KB
Loading
-2.11 KB
Loading

0 commit comments

Comments
 (0)