Repository: OpenMined/PySyft

Stars: 9873

README.md

<h3> Data Science on data you are not allowed to see</h3>

PySyft enables a new way to do data science, where you can use non-public information, without seeing nor obtaining a copy of the data itself. All you need is to connect to a <a href="https://docs.openmined.org/en/latest/components/datasite-server.html">Datasite</a>!

Datasites are like websites, but for data. Designed with the principles of <a href="https://arxiv.org/abs/2012.08347">structured transparency</a>, they enable data owners to control how their data is protected and data scientists to use data without obtaining a copy.

PySyft supports any statistical analysis or machine learning, offering support for directly running Python code - even using third-party Python libraries.

<h4> Supported on:</h4>

✅ Linux
✅ macOS
✅ Windows
✅ Docker
✅ Kubernetes

Quickstart

Try out your <a href="https://docs.openmined.org/en/latest/index.html">first query against a live demo Datasite! </a>

Install Client

bash

pip install -U "syft[data_science]"

More instructions are available <a href="https://docs.openmined.org/en/latest/quick-install.html">here</a>.

Launch Server

Launch <a href="https://docs.openmined.org/en/latest/deployment/deployment-doc-1-2-intro-req.html">a development server </a> directly in your Jupyter Notebook:

python

import syft as sy
sy.requires(">=0.9.5,<0.9.6")server = sy.orchestra.launch(
    name="my-datasite",
    port=8080,
    create_producer=True,
    n_consumers=1,
    dev_mode=False,
    reset=True, # resets database
)

or from the command line:

bash

$ syft launch --name=my-datasite --port=8080 --reset=TrueStarting syft-datasite server on 0.0.0.0:8080

Datasite servers can be deployed as a single container using Docker or directly in Kubernetes. Check out our <a href="https://docs.openmined.org/en/latest/deployment/deployment-doc-1-2-intro-req.html">deployment guide.</a>

Launch Client

Main way to use a Datasite is via our Syft client, in a Jupyter Notebook. Check out our <a href="https://docs.openmined.org/en/latest/components/syft-client.html"> PySyft client guide</a>:

python

import syft as sy
sy.requires(">=0.9.5,<0.9.6")datasite_client = sy.login(
    port=8080,
    email="[email protected]",
    password="changethis"
)

PySyft - Getting started 📝

Learn about PySyft via our getting started guide:

- <a href="https://docs.openmined.org/en/latest/getting-started/introduction.html">PySyft from the ground up</a>
- <a href="https://docs.openmined.org/en/latest/getting-started/part1-dataset-and-assets.html"> Part 1: Datasets & Assets</a>
- <a href="https://docs.openmined.org/en/latest/getting-started/part2-datasite-access.html"> Part 2: Client and Datasite Access</a>
- <a href="https://docs.openmined.org/en/latest/getting-started/part3-research-study.html"> Part 3: Propose the research study</a>
- <a href="https://docs.openmined.org/en/latest/getting-started/part4-review-code-request.html"> Part 4: Review Code Requests</a>
- <a href="https://docs.openmined.org/en/latest/getting-started/part5-retrieving-results.html"> Part 5: Retrieving Results</a>

PySyft In-depth

📚 Check out <a href="https://docs.openmined.org/en/latest/index.html">our docs website</a>.

Quick PySyft components links:

- <a href="https://docs.openmined.org/en/latest/components/datasite-server.html">DataSite Server</a>

- <a href="https://docs.openmined.org/en/latest//components/syft-client.html">Syft Client</a>

- <a href="https://docs.openmined.org/en/latest/components/datasets.html">Datasets API (.datasets)</a>

- <a href="https://docs.openmined.org/en/latest/components/users-api.html">Users API (.users)</a>

- <a href="https://docs.openmined.org/en/latest/components/requests-api.html">Request API (.requests)</a>

- <a href="https://docs.openmined.org/en/latest/components/code-api.html">Code API (.code)</a>

- <a href="https://docs.openmined.org/en/latest/components/syft-policies.html">Syft Policies API (.policy)</a>

- <a href="https://docs.openmined.org/en/latest/components/settings-api.html">Settings API (.settings)</a>

- <a href="https://docs.openmined.org/en/latest/components/notifications.html">Notifications API (.notifications)</a>

- <a href="https://docs.openmined.org/en/latest/components/syncing-api.html">Sync API (.sync)</a>

Why use PySyft?

In a variety of domains across society, data owners have valid concerns about the risks associated with sharing their data, such as legal risks, privacy invasion (_misuing the data_), or intellectual property (_copying and redistributing it_).

Datasites enable data scientists to answer questions without even seeing or acquiring a copy of the data, within the data owners's definition of acceptable use. We call this process <b> Remote Data Science</b>.

This means that the current risks of sharing information with someone will no longer prevent the vast benefits such as innovation, insights and scientific discovery. With each Datasite, data owners are able to enable 1000x more accesible data in each scientific field and lead, together with data scientists, breakthrough innovation.

Learn more about our work on <a href="https://openmined.org/">our website</a>.

Support

For questions about PySyft, reach out via #support on <a href="https://slack.openmined.org/">Slack</a>.

Syft Versions

:exclamation: PySyft and Syft Server must use the same version.

Latest Stable

- 0.9.5 (Stable) - <a href="https://docs.openmined.org/en/latest/index.html">Docs</a>
- Install PySyft (Stable): pip install -U syft

Find more about previous <a href="./releases.md">releases here</a>.

Community

Supported by the OpenMined Foundation, the OpenMined Community is an online network of over 17,000 technologists, researchers, and industry professionals keen to _unlock 1000x more data in every scientific field and industry_.

Courses

Contributors

OpenMined and Syft appreciates all contributors, if you would like to fix a bug or suggest a new feature, please reach out via <a href="https://github.com/OpenMined/PySyft/issues">Github</a> or <a href="https://join.slack.com/t/openmined/shared_invite/zt-2hxwk07i9-HO7u5C7XOgou4Z62VU78zA/">Slack</a>!

About OpenMined

OpenMined is a non-profit foundation creating technology infrastructure that helps researchers get answers from data without needing a copy or direct access. Our community of technologists is building Syft.

Supporters

</a>
</th>
<th align="center">
<a href="https://arkhn.org/">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/img/logo_arkhn.png">
<img src="docs/img/logo_arkhn_light.png" />
</picture>
</a>
</th>
</tr>
</table>

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>

Repository: OpenMined/PySyft

Stars: 9873

README.md Copy Chapter

Quickstart

Install Client Copy Chapter

Launch Server Copy Chapter

Launch Client Copy Chapter

PySyft - Getting started 📝 Copy Chapter