Skip to content

README-PYPI.md

Latest commit

 

History

History
75 lines (53 loc) · 4.17 KB

README-PYPI.md

File metadata and controls

75 lines (53 loc) · 4.17 KB
Raw

DP Wizard

pypi

DP Wizard makes it easier to get started with differential privacy, the addition of calibrated noise to aggregate statistics to protect the privacy of individuals. DP Wizard demonstrates how to calculate DP statistics or create a synthetic dataset from the data you provide.

Note

This software is part of the OpenDP Commons. As such, the OpenDP Executive Committee commits to:

  • Releasing this software under an OSI approved license, in this case the MIT License.
  • Ensuring there are at least two maintainers, in this case Eddie de Leon (eddiestudies) and Chuck McCallum (mccalluc), who will respond within a week to new issues and PRs.
  • Only making changes on main through PRs, and getting approval on these PRs before merging.
  • On an annual basis, recruiting one or more volunteers (not active contributors) who will conduct a health-check, focused not on the details of the algorithms but on the health of this repo as open source software. Their report will be linked here. The next (and first) health-check is scheduled for September 2026.

If differential privacy is new to you, these slides provide some background, and explain how DP Wizard works.

Options for running DP Wizard:

See the FAQ for more information.

Screenshots

Select Dataset: Screenshot with a "Data Source" panel on the left, and "Unit of Protection" and "Product" on the right.

Define Analysis: Screenshot with four panels: "Columns", "Grouping", "Privacy Budget", and "Simulation".

Download Results: Screenshot with links to download analysis results".

Usage

DP Wizard requires Python 3.10 or later. You can check your current version with python --version. The exact upgrade process will depend on your environment and operating system.

Install with pip install 'dp_wizard[pins]' and you can start DP Wizard from the command line.

usage: dp-wizard [-h] [--demo] [--host HOST] [--port PORT] [--no_browser] [--reload]

DP Wizard makes it easier to get started with Differential Privacy.

options:
  -h, --help    show this help message and exit
  --demo      Generate a demo CSV: See how DP Wizard works without providing your own data
  --host HOST   Bind socket to this host
  --port PORT   Bind socket to this port. If 0, a random port will be used.
  --no_browser  By default, a browser is started; Enable this for no browser.
  --reload      Enable to watch source directory and reload on changes.

Unless you have set "--demo", you will specify a CSV or TSV inside the application.

Provide a "Private Data" if you only have a private data set, and want to
make a release from it: The preview visualizations will only use
simulated data, and apart from the headers, the private data is not
read until the release.

Provide a "Public Data" if you have a public data set, and are curious how
DP can be applied: The preview visualizations will use your public data.

Provide both if you have two CSVs or TSVs with the same structure.
Perhaps the public data is older and no longer sensitive. Preview
visualizations will be made with the public data, but the release will
be made with private data.