Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Update README.md #112

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update README.md #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<a href="https://www.linkedin.com/pulse/microsoft-harvards-institute-quantitative-social-science-john-kahan/"><img src="images/SmartNoise_Logos/SVG/LogoMark_color.svg" align="left" height="65" vspace="8" hspace="18"></a>
## SmartNoise Samples: Differential Privacy Examples, Notebooks and Documentation
Please see the accompanying [SmartNoise Documentation](https://docs.opendp.org/en/latest/smartnoise/), [SmartNoise SDK repository](https://github.com/opendifferentialprivacy/smartnoise-sdk) and [SmartNoise Core repository](https://github.com/opendifferentialprivacy/smartnoise-core) for this system.
Please see the accompanying [SmartNoise Documentation](https://docs.smartnoise.org), [SmartNoise SDK repository](https://github.com/opendifferentialprivacy/smartnoise-sdk) and [SmartNoise Core repository](https://github.com/opendifferentialprivacy/smartnoise-core) for this system.


##
Expand All @@ -16,11 +16,11 @@ Differential privacy is the gold standard definition of privacy protection. The

## Sample Notebooks

[<img src="images/figs/plugin_mean_comparison.png" alt="Relative error distributions" height="100">](https://github.com/opendifferentialprivacy/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_size.png" alt="Release box plots" height="100">](https://github.com/opendifferentialprivacy/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_education.png" alt="Histogram releases" height="100">](https://github.com/opendifferentialprivacy/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_utility.png" alt="Utility simulations" height="100">](https://github.com/opendifferentialprivacy/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_simulations.png" alt="Bias simulations" height="100">](https://github.com/opendifferentialprivacy/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/plugin_mean_comparison.png" alt="Relative error distributions" height="100">](https://github.com/opendp/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_size.png" alt="Release box plots" height="100">](https://github.com/opendp/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_education.png" alt="Histogram releases" height="100">](https://github.com/opendp/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_utility.png" alt="Utility simulations" height="100">](https://github.com/opendp/smartnoise-samples/tree/master/analysis)
[<img src="images/figs/example_simulations.png" alt="Bias simulations" height="100">](https://github.com/opendp/smartnoise-samples/tree/master/analysis)

This repository includes several sets of sample Python notebooks that demonstrate SmartNoise functionality:

Expand All @@ -30,12 +30,6 @@ This repository includes several sets of sample Python notebooks that demonstrat
- [SQL Data Access](/data) - Code examples and notebooks show how to issue SQL queries against CSV files, database engines, and Spark clusters.
- [SmartNoise Whitepaper Demo Notebooks](/whitepaper-demos) - Based on the whitepaper titled [Microsoft SmartNoise Differential Privacy Machine Learning Case Studies](https://azure.microsoft.com/en-us/resources/microsoft-smartnoisedifferential-privacy-machine-learning-case-studies/) these notebooks include a demonstration of how to perform supervised machine learning with differential privacy and an example of creating a synthetic dataset with high utility for machine learning as well as examples of creating DP releases with histograms and protecting against a reidentification attack.

## API Reference Documentation

[Core Library Reference](https://opendp.github.io/smartnoise-core-python/): The Core Library implements the runtime validator and execution engine. Documentation is available for:
- [Python](https://opendp.github.io/smartnoise-core-python/) - https://opendp.github.io/smartnoise-core-python/)
- [Rust](https://opendp.github.io/smartnoise-core/doc/smartnoise_validator/docs/components/index.html) - https://opendp.github.io/smartnoise-core/doc/smartnoise_validator/docs/components/

## Communication

- You are very welcome to join us on [GitHub Discussions](https://github.com/opendp/opendp/discussions/categories/smartnoise)!
Expand All @@ -44,7 +38,7 @@ This repository includes several sets of sample Python notebooks that demonstrat

## Releases and Contributing

Please let us know if you encounter a bug by [creating an issue](https://github.com/opendifferentialprivacy/smartnoise-samples/issues).
Please let us know if you encounter a bug by [creating an issue](https://github.com/opendp/smartnoise-samples/issues).

We appreciate all contributions. We welcome pull requests with bug-fixes without prior discussion.

Expand Down