PyGrid Node is a server based application used by the PyGrid Platform.

Overview

• Start Grid Nodes Locally
• Try out the Tutorials
• Start Contributing
• Disclaimer
• License

Start Grid Nodes locally

Using Python

To start a grid node using python, run:

python grid_node.py 

You can pass the arguments or use environment variables to set the grid node configs.

Arguments

  -h, --help                shows the help message and exit
  --id [ID]                 the grid node identifier, e.g. --id=alice.
  -p [PORT], --port [PORT]  port to run the server on
  --host [HOST]             the grid node host
  --gateway_url [URL]       address used to join a Grid Network.
  --db_url [URL]            REDIS database server address

Environment Variables

• ID - The grid node identifier
• PORT - Port to run server on.
• ADDRESS - The grid node address/host
• REDISCLOUD_URL - The redis database URL
• GRID_GATEWAy_URL - The address used to join a Grid Network

Docker

The latest PyGrid Node image are available on the Docker Hub

PyGrid Node Docker image - openmined/grid-node

Pulling images

$ docker pull openmined/grid-node  # Download grid node image

Build your own PyGrid Node image

$ docker build openmined/grid-node . # Build grid node image

Try out the Tutorials

A comprehensive list of tutorials can be found here.

These tutorials cover how to create a PyGrid node and what operations you can perform.

Start Contributing

The guide for contributors can be found here. It covers all that you need to know to start contributing code to PyGrid in an easy way.

Also join the rapidly growing community of 7300+ on Slack. The slack community is very friendly and great about quickly answering questions about the use and development of PyGrid/PySyft!

We also have a Github Project page for a Federated Learning MVP here.
You can check the PyGrid's official development and community roadmap here.

Disclaimer

Do NOT use this code to protect data (private or otherwise) - at present it is very insecure.

License

Apache License 2.0