Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dvadym committed Jan 31, 2022
1 parent 3748bd5 commit 7ea827f
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ to bring Differential Privacy to production.

Here are some examples of how to use PipelineDP:

* [Apache Spark example](examples/movie_view_ratings/run_on_spark.py)
* [Apache Beam example](examples/movie_view_ratings/run_on_beam.py)
* [Framework-free example](examples/movie_view_ratings/run_without_frameworks.py)
* [Example with all frameworks](examples/movie_view_ratings/run_all_frameworks.py)
* [Apache Spark example](https://github.com/OpenMined/PipelineDP/blob/main/examples/movie_view_ratings/run_on_spark.py)
* [Apache Beam example](https://github.com/OpenMined/PipelineDP/blob/main/examples/movie_view_ratings/run_on_beam.py)
* [Framework-free example](https://github.com/OpenMined/PipelineDP/blob/main/examples/movie_view_ratings/run_without_frameworks.py)
* [Example with all frameworks](https://github.com/OpenMined/PipelineDP/blob/main/examples/movie_view_ratings/run_all_frameworks.py)

Please check out the [codelab](https://github.com/OpenMined/PipelineDP/blob/main/examples/restaurant_visits.ipynb) for a more detailed demonstration of the API functionality and usage.

Expand Down Expand Up @@ -75,8 +75,18 @@ dp_result.saveAsTextFile(FLAGS.output_file)

## Installation

PipelineDP without any frameworks:

`pip install pipeline-dp`

If you like to run PipelineDP on Apache Spark:

`pip install pipeline-dp pyspark`

on Apache Beam:

`pip install pipeline-dp apache-beam`.

Supported Python version >= 3.7.

**Note for Apple Silicon users:** PipelineDP pip package is currently available only
Expand Down

0 comments on commit 7ea827f

Please sign in to comment.