Skip to content

Improved the Example structure#224

Merged
chinmayshah99 merged 2 commits intoOpenMined:devfrom
chinmayshah99:example-struct
Aug 9, 2020
Merged

Improved the Example structure#224
chinmayshah99 merged 2 commits intoOpenMined:devfrom
chinmayshah99:example-struct

Conversation

@chinmayshah99
Copy link
Copy Markdown
Member

Description

Please include a summary of the change, the motivation, and any additionl context that will help others understand your PR. If it closes one or more open issues, please tag them as described here.

Affected Dependencies

List any dependencies that are required for this change.

How has this been tested?

  • Describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • List any relevant details for your test configuration.

Checklist

Comment thread examples/README.md

In this directory, we give a simple example of how to use the Python Differential
Privacy library.
## Curated list of Tutorials and Sample code for PyDP!
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can paraphrase it to "A Curated List of PyDP tutorials with code sample".

Comment thread examples/README.md
the animals as many carrots as they desire. The animals record how many carrots
they have eaten per day. For this particular day, the number of carrots eaten
can be seen in `animals_and_carrots.csv`.
### Tutorials
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need create extra title called Tutorials

Comment thread examples/README.md
each day, so he knows how many to order the next day. The animals are fearful
that Alex will use the data against their best interest. For example, Alex could
get rid of the animals who eat the most carrots!
#### Carrots Demo
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

number it (maybe later when we have the restautant demo)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have "error handling" as example 2 so better number them as - 1 and 2 respectively.

Comment thread examples/README.md
animals can control the risk that Alex will identify individuals' data while
maintaining an adequate level of accuracy so that Alex can continue to run the
zoo effectively.
This is the first example using the PyDP, about animals using the library to aggregate their data (about how many carrots they have eaten) before reporting it to their owner. More about it [here](carrots_demo/README.md).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"about animals using the library" ???? we want to give an idea of what the example is about - so can put it like this

"Farmer Alex's zoo has around 182 animals. Every day, Alex feeds the animals as many carrots as they desire. The animals record how many carrots they have eaten per day. At the end of each day, Alex often asks aggregate questions about how many carrots everyone ate. The animals decided to use Differential Privacy Library to preserve their privacy. Learn more about it [here]."

Comment thread examples/README.md

Each row in `animals_and_carrots.csv` is composed of the name of an animal, and
the number of carrots it has eaten, comma-separated.
### Example
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can push tutorials folder to examples folder - for better understanding and leave error handling in the example folder

@@ -0,0 +1,42 @@
# Example using Differential Privacy library
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to specify it again but i guess it's ok!

@chinmayshah99 chinmayshah99 merged commit 2cec4ff into OpenMined:dev Aug 9, 2020
@chinmayshah99 chinmayshah99 deleted the example-struct branch August 9, 2020 11:20
@Frank-7 Frank-7 changed the title Imporved the Example structure Improved the Example structure Aug 18, 2020
dvadym pushed a commit to dvadym/PyDP that referenced this pull request Jul 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants