search

OpenMined / PyDP

The Python Differential Privacy Library. Built on top of: https://github.com/google/differential-privacy
Apache License 2.0
501 stars 139 forks source link

Add Readme for Restaurant Demo #313

Closed shaistha24 closed 3 years ago

shaistha24 commented 3 years ago

Where?

https://github.com/OpenMined/PyDP/tree/dev/examples/restaurant_demo

Who?

Anyone checking out the Restaurant demo

What?

Add a description for the audience to understand the demo properly.

Additional Context

Reference Carrot Demo Readme: https://github.com/OpenMined/PyDP/tree/dev/examples/carrots_demo Google's readme: https://github.com/google/differential-privacy/tree/main/examples/java

mhosankalp commented 3 years ago

Hi, Can I take this one up?

Thanks and Regards, Sankalp

chinmayshah99 commented 3 years ago

Hi @mhosankalp, how is this coming along?

mhosankalp commented 3 years ago

Hi @chinmayshah99, I have completed it. How can I get it reviewed. As of now I have placed under my GitHub repository. Please see link below: https://github.com/mhosankalp/Restaurant_Demo

Thanks and Regards, Sankalp

chinmayshah99 commented 3 years ago

Hi @mhosankalp this looks great. You need to fork the pydp repo. Since this is a readme file, you can directly upload this file in https://github.com/OpenMined/PyDP/tree/dev/examples/restaurant_demo folder, creating the filename as README.md.

Feel free to reach out on #lib_pydp channel on slack for more help.

shaistha24 commented 3 years ago

@mhosankalp Hi, I would like to ask you to mention that it's the PyDP lib version of Google Differential Privacy Lib Java demo Google's readme: https://github.com/google/differential-privacy/tree/main/examples/java

At one glance it looks exactly like Google's Readme which is completely fine, but pls do see that the code snippets and the other materials are shared from PyDP. If you have done so then that's well and good! Else I would like to give gentle reminder to check it.

Also could you pls mention PyDP in the title.

Other than that everything looks great! Nicely done @mhosankalp

mhosankalp commented 3 years ago

Hi @shaistha24, Thanks for reviewing. I made sure we have snippet and graph as per PyDp code.I have excluded text which was not relevant to us. I did one more round of review now and I see all the text is as per PyDp Code. Header is also updated to include PyDp. Thanks and Regards, Sankalp

chinmayshah99 commented 3 years ago

Can you create the PR?

mhosankalp commented 3 years ago

@chinmayshah99 have created the PR

chinmayshah99 commented 3 years ago

Fixed in #324