Awesome

Perform data science on data that remains in someone else's server

Quickstart

✅ Linux ✅ macOS ✅ Windows* ✅ Docker ✅ Kubernetes

Install Client

$ pip install -U syft -f https://whls.blob.core.windows.net/unstable/index.html

Launch Server

# from Jupyter / Python
import syft as sy
sy.requires(">=0.8.1,<0.8.2")
node = sy.orchestra.launch(name="my-domain", port=8080, dev_mode=True, reset=True)

# or from the command line
$ syft launch --name=my-domain --port=8080 --reset=True

Starting syft-node server on 0.0.0.0:8080

Launch Client

import syft as sy
sy.requires(">=0.8.1,<0.8.2")
domain_client = sy.login(port=8080, email="info@openmined.org", password="changethis")

PySyft in 10 minutes

📝 <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api">API Example Notebooks</a>

• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/00-load-data.ipynb">00-load-data.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/01-submit-code.ipynb">01-submit-code.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/02-review-code-and-approve.ipynb">02-review-code-and-approve.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/03-data-scientist-download-result.ipynb">03-data-scientist-download-result.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/04-jax-example.ipynb">04-jax-example.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/05-custom-policy.ipynb">05-custom-policy.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/06-multiple-code-requests.ipynb">06-multiple-code-requests.ipynb</a>
• <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8/07-domain-register-control-flow.ipynb">07-domain-register-control-flow.ipynb</a>

Deploy Kubernetes Helm Chart

$ kubectl create namespace syft
$ helm install my-domain syft --namespace syft --version 0.8.1 --repo https://openmined.github.io/PySyft/helm

Azure or GCP Ingress

$ helm install ... --set ingress.ingressClass="azure/application-gateway"
$ helm install ... --set ingress.ingressClass="gce"

Deploy to a Container Engine or Cloud

1. Install our handy 🛵 cli tool which makes deploying a Domain or Gateway server to Docker or VM a one-liner:
   pip install -U hagrid

2. Then run our interactive jupyter Install 🧙🏽‍♂️ Wizard^BETA:
   hagrid quickstart

3. In the tutorial you will learn how to install and deploy:
   PySyft = our numpy-like 🐍 Python library for computing on private data in someone else's Domain

   PyGrid = our 🐳 docker / 🐧 vm Domain & Gateway Servers where private data lives

Docs and Support

• 📚 <a href="https://openmined.github.io/PySyft/">Docs</a>
• #support on <a href="https://slack.openmined.org/">Slack</a>

Install Notes

• HAGrid 0.3 Requires: 🐍 python 🐙 git - Run: pip install -U hagrid
• Interactive Install 🧙🏽‍♂️ Wizard^BETA Requires 🛵 hagrid: - Run: hagrid quickstart
• PySyft 0.8.1 Requires: 🐍 python 3.9 - 3.11 - Run: pip install -U syft
  *Windows users must run this first: pip install jaxlib==0.4.10 -f https://whls.blob.core.windows.net/unstable/index.html
• PyGrid Requires: 🐳 docker, ☸️ kubernetes or 🐧 ubuntu VM - Run: hagrid launch ...

Versions

0.9.0 - Coming soon...
0.8.2 (Beta) - dev branch 👈🏽 <a href="https://github.com/OpenMined/PySyft/tree/dev/notebooks/api/0.8">API</a> - Coming soon...
0.8.1 (Stable) - <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8">API</a>

Deprecated:

• 0.8.0 - <a href="https://github.com/OpenMined/PySyft/tree/0.8/notebooks/api/0.8">API</a>
• 0.7.0 - <a href="https://github.com/OpenMined/courses/tree/introduction-to-remote-data-science-dev">Course 3 Updated</a>
• 0.6.0 - <a href="https://github.com/OpenMined/courses/tree/introduction-to-remote-data-science">Course 3</a>
• 0.5.1 - <a href="https://github.com/OpenMined/courses/tree/foundations-of-private-computation">Course 2</a> + M1 Hotfix
• 0.2.0 - 0.5.0

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:

PySyft (Stable): pip install -U syft
PyGrid (Stable) hagrid launch ... tag=latest

PySyft (Beta): pip install -U syft --pre
PyGrid (Beta): hagrid launch ... tag=beta

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

What is Syft?

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, Differential Privacy, and Encrypted Computation. 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.

Why should I use Syft?

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.

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.

Terminology

Provide datasets which they would like to make available for study by an outside party they may or may not fully trust has good intentions.

Are end users who desire to perform computations or answer a specific question using one or more data owners' datasets.

Manages the remote study of the data by a Data Scientist and allows the Data Owner to manage the data and control the privacy guarantees of the subjects under study. It also acts as a gatekeeper for the Data Scientist's access to the data to compute and experiment with the results.

Provides services to a group of Data Owners and Data Scientists, such as dataset search and bulk project approval (legal / technical) to participate in a project. A gateway server acts as a bridge between it's members (Domains) and their subscribers (Data Scientists) and can provide access to a collection of domains at once.</td>

Community

<a href="https://slack.openmined.org/"><img src="https://raw.githubusercontent.com/OpenMined/PySyft/0.8.1/docs/img/panel_slack.png" alt="" width="100%" align="center" /></a>

<a href="https://blog.openmined.org/work-on-ais-most-exciting-frontier-no-phd-required/"><img src="https://raw.githubusercontent.com/OpenMined/PySyft/0.8.1/docs/img/panel_padawan.png" alt="" width="100%" align="center"></a>

Courses

Contributors

OpenMined and Syft appreciates all contributors, if you would like to fix a bug or suggest a new feature, please see our guidelines.<br />

Supporters

Open Collective

OpenMined is a fiscally sponsored 501(c)(3) in the USA. We are funded by our generous supporters on <a href="https://opencollective.com/openmined">Open Collective</a>. <br /><br />

Disclaimer

Syft is under active development and is not yet ready for pilots on private data without our assistance. As early access participants, please contact us via Slack or email if you would like to ask a question or have a use case that you would like to discuss.

License

Apache License 2.0<br /> <a href="https://www.flaticon.com/free-icons/person" title="person icons">Person icons created by Freepik - Flaticon</a>