| To be done | Achievements | Comments/blockers | |
|---|---|---|---|
| May 16th - June 22th | - Onboarding |
Week 1:
Finalised 1st draft of the README structure (need to incorporate feedback)
Started structuring the getting started guide Started watching the Introduction to Remote Data Science | - Move notebook to a different branch | | Pre-evaluation #1: June 13th | | | | | Evaluation #1: June 20th | - README.md on hold, a few meetings but unclear how to put the few commands into one (terminalizer); Madhava comment regarding it is hard to overlap the personas, “take me to the data science course on my machine” - CI tools notebook; RST documentation we have;
Madhava compiling a few presentations to be shared from which we can compile a infographic: three personas would make sense
Terminalizer for Quick Start: this is high importance, might be a bit slow (use a placeholder and say what you’d like to be in there)
Installed everything, but what “to do next” → for each personas → add a command to hagrid which launches a jupyter environment and use the notebook to do the rest ( use some software to manage the envs, maybe with some customization to specify the syft)
Clean the notebooks/ folder -
Repurpose the med notebooks for ‘data owner’
Installation guide
Add a place in the website, saying ‘Resources’ (talks) - gather resources from everyone in the community and Madhava could filter them | Completed Our Privacy Opportunity Got First PR merged for the linux installation command fix Read about the framework Met Mrinal too xD Debugged and deployed the API Documentation
Finalised 1st draft of the README structure (need to incorporate feedback)
Started structuring the getting started guide Started watching the Introduction to Remote Data Science | - mid remote data science course
how to run syft & hagrid
fix deployment of existing docs
there are a few modules which are not rendered
proposed README → a couple of meetings to see how to do it
First notebook in the intro to temote data science
Looking into front facing docs “syft.login”
What to do after deploying the container
notebooks/ folder to be moved to a different branch
People wont even look at the code if they cant make use of the lib
Break down the barrier of entry:
creating conceptual documentation around how everything works
building notebook that run them in the CI | | June 23th - July 22th | - README for Quick start
Getting started section + installation tutorials
Tool for getting started combining hagrid, jupyter and having a more interactive experience
Resources page Call for resources 🙂 and drafting the page | | | | Pre-evaluation #2: July 11th | - Installation tutorials to get merged
Hagrid quickstart to be started | - Resources page done
Installation tutorials
Progress on the README | | | Evaluation #2: July 18th | @Anonymous | @Anonymous | | | July 23th - August 22th | | | | | Pre-evaluation #3: August 11th | | | | | Evaluation #3: August 18th | | | | | August 23th - September 22th | | | | | Pre-evaluation #4: September 12th | | | | | Evaluation #4: September 19th | | | | | September 23th - October 22th | | | | | Pre-evaluation #5: October 10th | | | | | Evaluation #5: October 17th | | | | | October 23th - November 22th | | | | | Pre-evaluation #6: November 10th | | | | | Evaluation #6: November 17th | | | |
| To be done | Achievements | Comments/blockers | |
|---|---|---|---|
| May 16th - June 22th | - Onboarding |
Bonus points:
Bonus points:
Open Discussion with mentors to familiarize OpenMined's working style and ethics. 1.1 Attended a knowledge sharing session with Kyoko and Madhava 1.1.1 Curated a list of tasks to be done like README->Quickstart guide.
The goal for this month will be to understand the structure of the existing documentation and get a more detailed wireframe of the project. 2.1 I Watched the Write the Docs conference video and went through the framework by Diataxis. 2.2 Curated a list of favourite personal docs resources 2.3 Watched Madhava's Remote Data Science Unleashed Conference Video 2.4 Watched the padawan beta-01 and part-2 video. | | | | | May 30 - June 5
June 6 - 12
June 13 - 19
_ Use #support on slack to audit — Use course 3 in notebook
[clone the repo PySyft cd docs > cd Source cd developer_guide > index.rst file here run rquirements.txt make html in source go to build and check files]
|
| Pre-evaluation #1: June 13th | | - CONTRIBUTING PR
README (WIP)
Auditing (in progress)
New framework
Learning via Padawan Series
Deciding tutorials | | | Evaluation #1: June 20th | - README will take a long time, draft an initial version and iteration with the feedback from the people; use placeholders for terminalizer, infographic; Madhava collecting pieces from presentations; reuse the existing elements from the medical notebooks;
Proposed new outline for tutorials on the browser (PySyft for Data Owner, PySyft for Domain Owner, Network Owner, Data Scientist, Compliance as an article) —- getting started: what a datascientist can do, what a dataowner can do fully-featured tutorial; What is the federated network;
README.md to explain the notebook folder
Command line tool to launch tutorial is a bit a lot (usually you want to understand things), creating playground and embedding a google colab in browser
Add the contributions one to PySyft repo
Point the existing docs to openmined.github.io docs
Delete readthedocs.io
Restructure main page into data owner, domain owner, network owner, developer (api reference included) | Existing period learning: getting introduction to all resources, watching Padawan videos, intro to remote data science; volunteering for the medical learning session
Padawan series was a bit confusing, lack of structure
Work on the README for quick start section,
Revamped the existing contributions and merged PR | | | June 23th - July 22th | - Creating open issues and having open discussions with community members
Selecting high-priority issues and working on them
Draft a plan with the GSOD team (Shubham, mentors) with what docs we want to build and how and ask for review and ideas → translate the plan into GitHub issues
Complete README work, integrating the reviews from mentors and community members: figuring out the infographic, outline and usage of the command line tool/playground
Finalize outlines for documenting the personas on the webpage
Add a brief README for the notebooks section of Github | June 20-27
README changes (infographics)
proposed an outline for Readme for notebook repo on GitHub
Working on the outlines and getting started section for user personas
Review and find insights from different versions of Docs
Designed infographic
worked on the getting started and README
Opened two issues on github i.e. getting started and readme for the notebook
June 27-July03
July 5 - 10
July 11-18
README first commit with starting few sections
Write tutorial from MFLP notebook (step1 → step7)
Write tutorial from MFLP notebook (step7 → stepn)
continue working on readme and tutorial
auditing blogs and resources for deciding new tutorials to work on | # Main Readme
design logo for PR
tagline in hackmd comments on README and ask andrew
references to old pygrid to be removed
https://github.com/OpenMined/PySyft/blob/dev/notebooks/medical-federated-learning-program/data-owners/data-owners-presentation.ipynb | | Pre-evaluation #2: July 11th | | - PR for new README (PySyft)
Aug 1- Aug 14
| Evaluation #3: August 18th | | | | | September 23th - October 22th | | | | | Pre-evaluation #5: October 10th | | | | | Evaluation #5: October 17th | | | | | October 23th - November 22th | | | | | Pre-evaluation #6: November 10th | | | | | Evaluation #6: November 17th | | | |