https://github.com/openmined/syft-data-science
RDS
https://github.com/openmined/syft-data-science
Last synced: 6 months ago
JSON representation
RDS
- Host: GitHub
- URL: https://github.com/openmined/syft-data-science
- Owner: OpenMined
- License: apache-2.0
- Created: 2025-01-08T00:19:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-15T17:17:40.000Z (6 months ago)
- Last Synced: 2025-07-16T13:38:52.947Z (6 months ago)
- Language: Python
- Homepage:
- Size: 2.33 MB
- Stars: 2
- Watchers: 5
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RDS
## Requirements
- [just](https://github.com/casey/just?tab=readme-ov-file#installation)
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
## Quick Install
## Installation
To install the syft-rds package in a new virtual env:
```
just install
```
## Running the demo
### In-memory full flow example
The notebook `notebooks/quickstart/full_flow.ipynb` contains a full example of how to use the syft-rds package from both the data scientist and the data owner perspective. This demo mocks most of the SyftBox functionality, and does not require running any services in the background.
### Full example with SyftBox
To run the RDS app on top of syftbox, we need to:
1. launch a syftbox server
2. launch syftbox clients for the data scientist and the data owner
3. run an RDS app on the data owner's datasite
4. (optional) run an RDS app on the data scientist's datasite
5. run the `notebooks/quickstart/do_flow.ipynb` and `notebooks/quickstart/ds_flow.ipynb` notebooks
Steps 1 through 4 can be done with a single just command:
```
just run-rds-stack
```
To run jupyter lab in the syft-rds environment:
```
just run-jupyter
```