Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create code examples for different tasks #282

Open
dvadym opened this issue May 25, 2022 · 4 comments
Open

Create code examples for different tasks #282

dvadym opened this issue May 25, 2022 · 4 comments
Assignees
Labels
Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase

Comments

@dvadym
Copy link
Collaborator

dvadym commented May 25, 2022

Context

Terminology can be found here.

There are 2 APIs:

  1. Core APIs - which represent by public functions of DPEngine (example of usage)
  2. High-level APIs: PrivatePCollection (Beam), PrivateRDD (Spark) are private counter-part of corresponding Beam/Spark objects.
    They have nice guarantee: only data that has been aggregated in a DP manner, using no more than the specified privacy budget, can be extracted (Beam example, Spark example).

It would be nice to have examples for all APIs.

Goals

There are several end-to-end examples on Github. The goal of this issue is to create examples with solving different tasks which PipelineDP user might have. Those examples might be snippets (not neccessary end-to-end). We will put them on pipelinedp.io on snippets web-page (to be created).

The initial list of those examples:

  1. How to compute 1 metric DP Count.
  2. How to compute 1 metric DP Sum.
  3. How to compute multiple metrics per at one aggregation.
  4. Using public_partitions.
  5. Computing histogram with VECTOR_SUM aggregation and 1-hot encoding.
  6. Computing DP aggregations for different values (i.e. by calling several times DPEngine.aggregate).
@dvadym dvadym added Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase labels May 25, 2022
@eswarijayakumar
Copy link

@dvadym I am interested in working on this. Please assign it to me

@dvadym
Copy link
Collaborator Author

dvadym commented May 25, 2022

Thank you!

@system-reboot
Copy link

@dvadym is this issue still open? I would love to contribute towards it.

@dvadym
Copy link
Collaborator Author

dvadym commented Nov 20, 2023

@system-reboot yes this issue is open and it will be useful to have more examples. You're welcome to contribute.

You can start with a simple example with COUNT. Please let me know if you have any questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Development

No branches or pull requests

3 participants