Skip to content

Commit

Permalink
final changes to README. ready to be made public
Browse files Browse the repository at this point in the history
  • Loading branch information
Vivek Khimani committed Nov 13, 2019
1 parent 1dfc2fa commit 71972e8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# Implementing Federated Learning using PySyft

### Basics:
- Dataset - MNIST
- Number of Workers - 32
- Classification Model - CNN (see the details in models directory)
- Tools Used - PySyft, PyTorch

### Instructions:
- Prerequisite: python3, pip3, pysyft, pytorch
- RUN: "main_fed.py"
- To edit the basic characteristics of the model, check "/utils/Arguments.py". No CLI has been provided for now.
- To edit the classification model, check "/models/CNN.py"


### Future Work:
- Add a CLI to make the process of editing the arguments easier.
- Facilitate training by selecting a subset of workers instead of using all the workers.

0 comments on commit 71972e8

Please sign in to comment.