Skip to content

Commit

Permalink
Merge branch 'dev' into settings_update
Browse files Browse the repository at this point in the history
  • Loading branch information
jcardonnet authored May 17, 2024
2 parents 17374ca + c10b0e4 commit 4409ee5
Show file tree
Hide file tree
Showing 28 changed files with 776 additions and 1,924 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,11 @@ For Google GKE we need the [`gce` annotation](https://cloud.google.com/kubernete
helm install ... --set ingress.class="gce"
```

## Deploy to a Container Engine or Cloud
## Note:

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`
🚨 Our deployment tool `Hagrid` has been `Deprecated`. For the updated deployment options kindly refer to

2. Then run our interactive jupyter Install 🧙🏽‍♂️ Wizard<sup>BETA</sup>:
`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
- 📚 <a href="https://github.com/OpenMined/PySyft/tree/dev/notebooks/tutorials/deployments">Deployments</a>

## Docs and Support

Expand All @@ -128,10 +121,8 @@ helm install ... --set ingress.class="gce"

# Install Notes

- HAGrid 0.3 Requires: 🐍 `python` 🐙 `git` - Run: `pip install -U hagrid`
- Interactive Install 🧙🏽‍♂️ Wizard<sup>BETA</sup> Requires 🛵 `hagrid`: - Run: `hagrid quickstart`
- PySyft 0.8.1 Requires: 🐍 `python 3.10 - 3.12` - Run: `pip install -U syft`
- PyGrid Requires: 🐳 `docker`, 🦦 `podman` or ☸️ `kubernetes` - Run: `hagrid launch ...`
- PyGrid Requires: 🐳 `docker`, 🦦 `podman` or ☸️ `kubernetes`

# Versions

Expand All @@ -154,13 +145,9 @@ Deprecated:

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`
PySyft (Stable): `pip install -U syft`

HAGrid is a cli / deployment tool so the latest version of `hagrid` is usually the best.
PySyft (Beta): `pip install -U syft --pre`

# What is Syft?

Expand Down
Loading

0 comments on commit 4409ee5

Please sign in to comment.