diff --git a/python/dp_auditorium/README.md b/python/dp_auditorium/README.md index 4a61b9e7..6be276ab 100644 --- a/python/dp_auditorium/README.md +++ b/python/dp_auditorium/README.md @@ -7,18 +7,18 @@ guarantees as described in the introductory paper The root directory is structured as follows. It contains four main folders and a runner module described below: -* [Testers](testers/): Contains modules introducing `PropertyTesters` that +* [Testers](dp_auditorium/testers/): Contains modules introducing `PropertyTesters` that check if there is evidence to reject the hypothesis that a privacy guarantee holds on a fixed pair of datasets. -* [Generators](generators/): Contains modules introducing `DatasetGenerators` +* [Generators](dp_auditorium/generators/): Contains modules introducing `DatasetGenerators` that output pairs of neighboring datasets, for example under the add/remove neighboring relation. -* [Mechanisms](mechanims/): Contains examples of private and non-private +* [Mechanisms](dp_auditorium/mechanisms/): Contains examples of private and non-private mechanisms used to exemplify testers. * `privacy_test_runner.py`: Module with runner that specializes to a tester and generator and instantiates the `PropertyTester` on several datasets' trials generated by the `DatasetGenerator`. -* [Examples](examples/): Folder containing examples on how to combine the +* [Examples](dp_auditorium/examples/): Folder containing examples on how to combine the above tools. Details on the signature of the above objects, can be found in the