PySyft icon indicating copy to clipboard operation
PySyft copied to clipboard

GSoD: Quickstart notebooks for data owners

Open IrinaMBejan opened this issue 3 years ago • 1 comments

Where?

We would like to extend the quickstart section of the documentation with the main remaining tutorials for the data owners:

  1. Create Network (@ShubhamPalriwala )
    • Learning objective: How data can be shared among multiple people, the concept of a network
  2. Join a network (@ShubhamPalriwala )
    • Learning Objective: How to discover networks and contribute to them
  3. Create Accounts + Manage Privacy Budget (@abhiwalia15 )
    • Learning objective: How to manage the access to your domain and uploaded dataset and why is it important

The first iteration of all notebooks should be ready for review by Friday (2nd).

Who?

New users to OpenMined looking to learn how to use PySyft and PyGrid as a data owner.

What?

  • [ ] Define create a network, join a network flow
  • [ ] Define functionalities to be showcased in the management of the privacy budget
  • [ ] Finish notebook tutorials in notebooks/quickstart
    • [ ] Create a network
    • [ ] Join a network
    • [ ] Create account + manage privacy budget
  • [ ] Add corresponding pages to docs/ section
    • [ ] Create a network
    • [ ] Join a network
    • [ ] Create account + manage privacy budget
  • [ ] Link tutorials in the README.md

Quality control (Linting and testing):

  • [ ] Make sure the notebooks run
  • [ ] Keep an eye out for formatting of code in cells
  • [ ] No excess spacing on headings
  • [ ] Use normal font size for main text and custom headings
  • [ ] Proofread spelling and punctuation
  • [ ] Check for consistency

IrinaMBejan avatar Aug 27 '22 13:08 IrinaMBejan

@IrinaMBejan Hey, can you assign this issue to me? Thanks

abhiwalia15 avatar Aug 27 '22 14:08 abhiwalia15

Hey @IrinaMBejan Now that all the PRs are open for this, can you reference them in the issue title itself so that it gets easier to track them?

ShubhamPalriwala avatar Oct 13 '22 11:10 ShubhamPalriwala