Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
koenvanderveen committed Dec 6, 2023
1 parent 28139e6 commit 0306463
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Perform data science on `data` that remains in `someone else's` server
## Install Client

```bash
$ pip install -U syft
$ pip install -U syft[data_science]
```

## Launch Server

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

Expand All @@ -38,7 +38,7 @@ Starting syft-node server on 0.0.0.0:8080

```python
import syft as sy
sy.requires(">=0.8.2,<0.8.3")
sy.requires(">=0.8.3,<0.8.4")
domain_client = sy.login(port=8080, email="[email protected]", password="changethis")
```

Expand Down Expand Up @@ -119,11 +119,12 @@ $ helm install ... --set ingress.ingressClass="gce"
# Versions

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

Deprecated:

- `0.8.2` - <a href="https://github.com/OpenMined/PySyft/tree/0.8.2/notebooks/api/0.8">API</a>
- `0.8.1` - <a href="https://github.com/OpenMined/PySyft/tree/0.8.1/notebooks/api/0.8">API</a>
- `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>
Expand Down

0 comments on commit 0306463

Please sign in to comment.