PySyft in Detail
A more detailed explanation of PySyft can be found in the paper on arxiv
PySyft has also been explained in video form by Siraj Raval
Optionally, we recommend that you install PySyft within the Conda virtual environment. If you are using Windows, I suggest installing Anaconda and using the Anaconda Prompt to work from the command line.
conda create -n pysyft python=3 conda activate pysyft # some older version of conda require "source activate pysyft" instead. conda install jupyter notebook
PySyft supports Python >= 3.6 and PyTorch 1.1.0
pip install syft
If you have an installation error regarding zstd, run this command and then re-try installing syft.
pip install --upgrade --force-reinstall zstd
If this still doesn't work, and you happen to be on OSX, make sure you have OSX command line tools installed and try again.
You can also install PySyft from source on a variety of operating systems by following this installation guide.
Run Local Notebook Server
All the examples can be played with by running the command
and selecting the pysyft kernel
Use the Docker image
Instead of installing all the dependencies on your computer, you can run a notebook server (which comes with Pysyft installed) using Docker. All you will have to do is start the container like this:
$ docker container run openmined/pysyft-notebook
You can use the provided link to access the jupyter notebook (the link is only accessible from your local machine).
You can also set the directory from which the server will serve notebooks (default is /workspace).
$ docker container run -e WORKSPACE_DIR=/root openmined/pysyft-notebook
You could also build the image on your own and run it locally:
$ cd docker-image $ docker image build -t pysyft-notebook . $ docker container run pysyft-notebook
More information about how to use this image can be found on docker hub
Try out the Tutorials
A comprehensive list of tutorials can be found here
These tutorials cover how to perform techniques such as federated learning and differential privacy using PySyft.
The guide for contributors can be found here. It covers all that you need to know to start contributing code to PySyft in an easy way.
Also join the rapidly growing community of 3700+ on Slack. The slack community is very friendly and great about quickly answering questions about the use and development of PySyft!
We have written an installation example in this colab notebook, you can use it as is to start working with PySyft on the colab cloud, or use this setup to fix your installation locally.
We are very grateful for contributions to PySyft from the following organizations!
Do NOT use this code to protect data (private or otherwise) - at present it is very insecure. Come back in a couple months.