Pysyft: Reactor: Make PySyft Beautiful Again (MPBA)

Created on 3 Aug 2018  路  1Comment  路  Source: OpenMined/PySyft

We are currently in the midst of a significant refactoring of PySyft in the pointers_are_tensors branch. As the refactor is feature-complete (sans bugs), it is now a top priority to ensure that the refactor has good code conventions and that the code is clean, organized, and readable.

This issue is a bit open ended, but if you're interested in this project, please read through the codebase (especially code in the "syft/code/frameworks" folder) and help us make it beautiful. In particular, functions have been grouped in a somewhat greedy fashion focusing on getting the unit tests to pass, and now we need to do another pass through the codebase asking the questions

NOTE: This is focused on the pointers_are_tensors branch (not master!!!)

  • Should this method/class really be just one function?
  • Should this method/class be combined with another function?
  • Is this method/class in the right class/file?
  • Is this method accidentally re-implementing something that already exists in a utility function
  • Do multiple methods re-implement the same piece of functionality (should be a utility function)
  • Are our abstractions well organized?
  • Are the names of our variables, classes, and methods as intuitive as possible? (this one definitely needs work)
  • Could I implement the same functionality in shorter/more intuitive code (go crazy with this!)
  • Is this code introducing any security vulnerabilities to the system? (for example: is it using "eval()")
  • etc

(feel free add more "good questions to ask about the codebase" to this issue in the comments section)

Good first issue Help Wanted Type

Most helpful comment

CC: @jvmancuso , @robert-wagner , @alhparsa

>All comments

CC: @jvmancuso , @robert-wagner , @alhparsa

Was this page helpful?
0 / 5 - 0 ratings

Related issues

robert-wagner picture robert-wagner  路  4Comments

aristizabal95 picture aristizabal95  路  3Comments

deevashwer picture deevashwer  路  4Comments

iamtrask picture iamtrask  路  3Comments

samsontmr picture samsontmr  路  3Comments