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

Added Laplace and Restaurant Demo Description. #319

Closed Rajatendu1 closed 3 years ago

Rajatendu1 commented 3 years ago

Added a short description about the new examples(Laplace and Restaurant) which have been added.

Description

Added Laplace and Demo description for the project README.md file

Affected Dependencies

None

How has this been tested?

Updated the README.md file, no testing required

Checklist

shaistha24 commented 3 years ago

Hi, @Rajatendu1 It doesn't make much sense to add which property of the PyDP is being used such as count etc. But, Instead giving a quick summary of what the demo is about - for example write the scenario and the cases being involved (quick one liner) in case of restaurant demo. That gives a better idea of what the demo is and what people can expect to see in it.

You may do the same for the Laplace demo. Also, would like to suggest to make a side heading for carrot demo too. kinda confusing as right now it looks like the intro line for the README.

You may check this - Googles style guide - : https://developers.google.com/style (formatting, style, language, grammar)

chinmayshah99 commented 3 years ago

@Rajatendu1 please make changes as suggested by @shaistha24

chinmayshah99 commented 3 years ago

Closing due to in-activity