Skip to content

Documentation update for 0.1.2 release#172

Merged
chinmayshah99 merged 1 commit intoOpenMined:devfrom
chinmayshah99:release/document-update
Jun 1, 2020
Merged

Documentation update for 0.1.2 release#172
chinmayshah99 merged 1 commit intoOpenMined:devfrom
chinmayshah99:release/document-update

Conversation

@chinmayshah99
Copy link
Copy Markdown
Member

Pull Request

Description

Please include a summary of the change and which issue is fixed. If this closes one or more open issues, please tag them as described here.

Affected Dependencies

List any dependencies that are required for this change.

Type of Change

Please mark options that are relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation (non-breaking change which adds documentation)
  • Improvement (non-breaking change that improves the performance or reliability of existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

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

Additional Context

Please also include relevant motivation and context.

@chinmayshah99 chinmayshah99 requested a review from jeamick June 1, 2020 09:50
Comment thread README.md
**Things to remember about PyDP :**
- :rocket: Features Differentially Private Algorithmic functions as part of the 0.1.1 dev release, added to carrots demo such as BoundedMean, BoundedSum, Max, Count Above, Percentile, Min, Median , etc.
- :rocket: Features Differentially Private Algorithmic functions to support carrots demo including: BoundedMean, BoundedSum, Max, Count Above, Percentile, Min, Median, etc.
- All the computation methods mentioned above, use Laplace noise only. (Other noise mechanisms will be added soon... :smiley:)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's add a link for the others mechanism or paper so people have an idea about what does it means:

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.

Great, I think we can add it to the learning resources @jeamick - to know more about DP and stuff. The readme should only describe the project. What do you think @chinmayshah99 ?

I think the current description is enough. But, as always any suggestions are welcome!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah @shaistha24 , we can add this to learning resources, and create a link from here in readme.
@shaistha24 Can you help us out here?

Copy link
Copy Markdown
Member

@jeamick jeamick left a comment

Choose a reason for hiding this comment

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

Looks good to me! I just added a little comment, let me guys know your thoughts about it.

@chinmayshah99 chinmayshah99 merged commit ffc8881 into OpenMined:dev Jun 1, 2020
@chinmayshah99 chinmayshah99 deleted the release/document-update branch June 1, 2020 12:14
@chinmayshah99
Copy link
Copy Markdown
Member Author

While I have merged this PR, @shaistha24 can you add links to explore further section and link it with the main readme?

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.

3 participants