Skip to content

Commit a7cc26a

Browse files
Differential Privacy TeamRamSaw
authored andcommitted
PipelineDP4j: update readmes
Change-Id: I349b873f1adf9a0e548ebb1e3ed7e0b2a7c30b58 GitOrigin-RevId: b164dd3b302b61013f257e821d14277e25320e57
1 parent bb0c5c5 commit a7cc26a

File tree

5 files changed

+8
-18
lines changed

5 files changed

+8
-18
lines changed

cc/algorithms/approx-bounds-provider.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ class ApproxBoundsProvider final : public BoundsProvider<T> {
169169

170170
RETURN_IF_ERROR(ValidateIsInExclusiveInterval(options.success_probability,
171171
0, 1, "Success probability"));
172+
172173
// Using `new` to access non-public constructor.
173174
return absl::WrapUnique(new ApproxBoundsProvider<T>(
174175
options.epsilon, options.num_bins, options.scale, options.base,

examples/pipelinedp4j/README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Here are the steps to build and run the example assuming you are in the
102102
```
103103

104104
1. Run the program (if you want to run Spark example, change `beam` to `spark`,
105-
`BeamExample` to `SparkExample` or `SparkDatasetExample` and
105+
`BeamExample` to `SparkExample` or `SparkDataFrameExample` and
106106
`--outputFilePath=output.txt` to `--outputFolder=output`):
107107

108108
```shell
@@ -124,12 +124,6 @@ utilizes a
124124
from the Maven repository, eliminating the need for the library source files and
125125
the Bazel files (`WORKSPACE.bazel`, `.bazelversion` and `BUILD.bazel`).
126126

127-
NOTE: Currently the version of examples at HEAD does not build with Maven
128-
because the examples were migrated to the new version of public API which has
129-
not been uploaded to the Maven repository yet. It will be uploaded in a few
130-
days. For now, use the version of examples from commit that preceded the commit
131-
when this note was created (use git blame).
132-
133127
To proceed, ensure Maven is installed on your system. If you're using Linux or
134128
MacOS, you can install it by running `sudo apt-get install maven` or `brew
135129
install maven`, respectively. While any Maven version should work, refer to
@@ -147,7 +141,7 @@ Once Maven is installed, navigate to the directory of a backend you want to use:
147141
* `examples/pipelinedp4j/spark` for Spark
148142
149143
Then execute the following command with updated `inputFilePath` (if you want to
150-
run on Spark, change `BeamExample` to `SparkExample` or `SparkDatasetExample`
144+
run on Spark, change `BeamExample` to `SparkExample` or `SparkDataFrameExample`
151145
and `--outputFilePath=output.txt` to `--outputFolder=output`):
152146
153147
```shell
@@ -159,7 +153,9 @@ output file paths.
159153
160154
View the results.
161155
162-
For Beam `cat output.txt` For Spark the output is written to a folder and the
156+
For Beam `cat output.txt`.
157+
158+
For Spark the output is written to a folder and the
163159
result is stored in a file whose name starts with `part-00000`: `cat
164160
output/part-00000<...>`
165161

java/BUILD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ load("@bazel_common//tools/maven:pom_file.bzl", "pom_file")
1818
load("@rules_jvm_external//:defs.bzl", "java_export")
1919

2020
# Update the following version for packaging of a new release.
21-
_DP_LIB_VERSION = "3.0.0"
21+
_DP_LIB_VERSION = "4.0.0"
2222

2323
exports_files([
2424
"dp_java_deps.bzl",

pipelinedp4j/BUILD.bazel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ kt_kotlinc_options(
3030
)
3131

3232
# Update the following version for packaging of a new release.
33-
_RELEASE_VERSION = "0.0.1"
33+
_RELEASE_VERSION = "4.0.0"
3434

3535
pom_file(
3636
name = "export_pom",

pipelinedp4j/README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ You can use PipelineDP4j in Java, Kotlin or Scala.
1818

1919
## How to Use
2020

21-
WARNING: Current API version (0.0.1) is experimental and will be changed in 2024
22-
without backward-compatibility. The experimental API won't be supported and
23-
maintained after that.
24-
2521
### Example
2622

2723
<!-- TODO: create codelab and rewrite this section. -->
@@ -44,6 +40,3 @@ dependency from Maven repository. You can find it
4440
[here](https://mvnrepository.com/artifact/com.google.privacy.differentialprivacy.pipelinedp4j/pipelinedp4j).
4541
After adding this dependency into your project you can write the same code as in
4642
the example above and it will compile.
47-
48-
Please, don't use `0.0.1` version in production code as it is experimental and
49-
its maintenance will be stopped in 2024 with release of the new version.

0 commit comments

Comments
 (0)