Skip to content

Create code examples for different tasks #282

@dvadym

Description

@dvadym

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).

Metadata

Metadata

Labels

Good first issue 🎓Perfect for beginners, welcome to OpenMined!Type: Documentation 📚Improvements or additions in documentation for some file, feature, or codebase

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions