/Best_time_to_commute_Android/Android_federated_learning/AndroidWorker/README.md

https://github.com/aksht94/UdacityOpenSource · Markdown · 29 lines · 19 code · 10 blank · 0 comment · 0 complexity · 219004d228c077ea57835942ab50494e MD5 · raw file 

    

  1. [![Build Status](https://travis-ci.org/OpenMined/AndroidWorker.svg?branch=master)](https://travis-ci.org/OpenMined/AndroidWorker)
    2. 

  2. 

  3. ![PySyft for Android](art/pysyft_android.png)
    4. 

  4. 

  5. See publication in [PySyft for Android. Extending OpenMined to mobile devices](https://medium.com/@mccorby/pysyft-android-b28da47a767e)
    6. 

  6. 

  7. # Android Worker
    8. 

  8. 

  9. The Android Worker is an app that connects to a PySyft worker and performs the operations on its behalf. It is part of a setup that uses a socket server, a socket client and the app itself which is another socket client
    10. 

  10. 

  11. ## Quick start
    12. 

  12. 

  13. * Start the socket server
    14. 

  14.   * There is an example provided in the code of Grid: `socketio_server_demo.py`
    15. 

  15. * Start a Jupyter notebook and create a `WebsocketIOClientWorker` object.
    16. 

  16.   * Note that you need to provide strategies for serialization and compression
    17. 

  17.   * See the example `examples/experimental/Sockets/Socket%20Bob.ipynb`
    18. 

  18. * Run the app
    19. 

  19. * Execute the operations in the notebook and see how Android handles them!
    20. 

  20. 

  21. #### Notes
    22. 

  22. * The project is still in an early stage and only some PySyft operations are implemented: `send`, `get`, `add`, `delete`, `mul`
    23. 

  23. * Make sure the socket server, the client in the notebook and the app all point to the same host/port
    24. 

  24. * To run the setup locally, it is better to use an Android emulator
    25. 

  25. 

  26. ## PySfyt Version
    27. 

  27. This app has been tested with PySyft 0.1.19a1
    28.