BenchmarkDPFair 0.2.5__tar.gz → 0.2.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. {benchmarkdpfair-0.2.5/src/BenchmarkDPFair.egg-info → benchmarkdpfair-0.2.6}/PKG-INFO +31 -13
  2. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/README.md +30 -12
  3. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/pyproject.toml +1 -1
  4. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6/src/BenchmarkDPFair.egg-info}/PKG-INFO +31 -13
  5. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/LICENSE +0 -0
  6. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/setup.cfg +0 -0
  7. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/__init__.py +0 -0
  8. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/benchmark.py +0 -0
  9. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/dataconf.py +0 -0
  10. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/__init__.py +0 -0
  11. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/auxiliar.py +0 -0
  12. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/benchmark.py +0 -0
  13. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/inp.py +0 -0
  14. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/pos.py +0 -0
  15. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/pre.py +0 -0
  16. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/types.py +0 -0
  17. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/Benchmark/utils/verifiers.py +0 -0
  18. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/DataGenerator/__init__.py +0 -0
  19. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/DataGenerator/dataconf.py +0 -0
  20. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/DataGenerator/datagen.py +0 -0
  21. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/DataGenerator/utils/verifiers.py +0 -0
  22. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair/__init__.py +0 -0
  23. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair.egg-info/SOURCES.txt +0 -0
  24. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair.egg-info/dependency_links.txt +0 -0
  25. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair.egg-info/requires.txt +0 -0
  26. {benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair.egg-info/top_level.txt +0 -0
{benchmarkdpfair-0.2.5/src/BenchmarkDPFair.egg-info → benchmarkdpfair-0.2.6}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: BenchmarkDPFair
3
- Version: 0.2.5
3
+ Version: 0.2.6
4
4
  Summary: A differentially private data synthesizer and fairness intervention benchmark framework
5
5
  Author-email: Vinicius Gabriel Angelozzi Verona de Resende <verona.projects@tutanota.com>, Héber Hwang Arcolezi <heber.hwang-arcolezi@etsmtl.ca>
6
6
  License: MIT License
@@ -70,27 +70,45 @@ This repository provides a Python framework for **benchmarking fairness mechanis
70
70
 
71
71
  ## Installation
72
72
 
73
- > From source
74
- To install, either use PyPi to isntall it, or clone the repository and install dependencies:
73
+ First, we strongly recommend creating a new Python environment before installing the package. This helps maintain a clean and reproducible setup, facilitates dependency and version management and update, and minimises potential conflicts with previously installed libraries.
75
74
 
76
75
  ```bash
77
- git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
78
- cd dp-fair-intervention-benchmark
79
-
80
76
  python3 -m venv dpfair-env
81
- source dpfair-env/bin/activate
77
+ source dpfair-env/bin/activate # On Windows: dpfair-env\\Scripts\\activate
78
+ # Installation approach via PyPi or source installation
79
+ ```
82
80
 
81
+ If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
82
+ ```bash
83
83
  pip install torch --index-url https://download.pytorch.org/whl/cpu
84
- pip install -e .
85
84
  ```
86
85
 
87
- > Using PyPi **(SUGGESTED)**
86
+ Users on MacOS are required to install `llvm-openmp`, either using conda or brew, as below:
87
+
88
+ **Conda**:
89
+ ```bash
90
+ conda install -c conda-forge llvm-openmp
91
+ ```
92
+ **Brew**:
93
+ ```bash
94
+ brew install libomp
95
+ ```
96
+
97
+ Then, the library installation can proceed as per usual.
98
+
99
+ Our recommended method is via PyPI. With a Python 3.9+ and <3.13 environment:
100
+
88
101
  ```bash
89
- python3 -m venv dpfair-env
90
- source dpfair-env/bin/activate
91
- pip install torch --index-url https://download.pytorch.org/whl/cpu
92
102
  pip install BenchmarkDPFair
93
- ````
103
+ ```
104
+
105
+ Alternatively, there is the possibility to install from source, which also gives access to the `data/`, `example/`, and `notebook/` directories (be aware that these may consume more resources on your disk given the data provided):
106
+
107
+ ```bash
108
+ git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
109
+ cd dp-fair-intervention-benchmark
110
+ pip install -e .
111
+ ```
94
112
 
95
113
  ---
96
114
 
{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/README.md RENAMED
@@ -16,27 +16,45 @@ This repository provides a Python framework for **benchmarking fairness mechanis
16
16
 
17
17
  ## Installation
18
18
 
19
- > From source
20
- To install, either use PyPi to isntall it, or clone the repository and install dependencies:
19
+ First, we strongly recommend creating a new Python environment before installing the package. This helps maintain a clean and reproducible setup, facilitates dependency and version management and update, and minimises potential conflicts with previously installed libraries.
21
20
 
22
21
  ```bash
23
- git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
24
- cd dp-fair-intervention-benchmark
25
-
26
22
  python3 -m venv dpfair-env
27
- source dpfair-env/bin/activate
23
+ source dpfair-env/bin/activate # On Windows: dpfair-env\\Scripts\\activate
24
+ # Installation approach via PyPi or source installation
25
+ ```
28
26
 
27
+ If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
28
+ ```bash
29
29
  pip install torch --index-url https://download.pytorch.org/whl/cpu
30
- pip install -e .
31
30
  ```
32
31
 
33
- > Using PyPi **(SUGGESTED)**
32
+ Users on MacOS are required to install `llvm-openmp`, either using conda or brew, as below:
33
+
34
+ **Conda**:
35
+ ```bash
36
+ conda install -c conda-forge llvm-openmp
37
+ ```
38
+ **Brew**:
39
+ ```bash
40
+ brew install libomp
41
+ ```
42
+
43
+ Then, the library installation can proceed as per usual.
44
+
45
+ Our recommended method is via PyPI. With a Python 3.9+ and <3.13 environment:
46
+
34
47
  ```bash
35
- python3 -m venv dpfair-env
36
- source dpfair-env/bin/activate
37
- pip install torch --index-url https://download.pytorch.org/whl/cpu
38
48
  pip install BenchmarkDPFair
39
- ````
49
+ ```
50
+
51
+ Alternatively, there is the possibility to install from source, which also gives access to the `data/`, `example/`, and `notebook/` directories (be aware that these may consume more resources on your disk given the data provided):
52
+
53
+ ```bash
54
+ git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
55
+ cd dp-fair-intervention-benchmark
56
+ pip install -e .
57
+ ```
40
58
 
41
59
  ---
42
60
 
{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "BenchmarkDPFair"
7
- version = "0.2.5"
7
+ version = "0.2.6"
8
8
  description = "A differentially private data synthesizer and fairness intervention benchmark framework"
9
9
  authors = [
10
10
  { name="Vinicius Gabriel Angelozzi Verona de Resende", email="verona.projects@tutanota.com" },
{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6/src/BenchmarkDPFair.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: BenchmarkDPFair
3
- Version: 0.2.5
3
+ Version: 0.2.6
4
4
  Summary: A differentially private data synthesizer and fairness intervention benchmark framework
5
5
  Author-email: Vinicius Gabriel Angelozzi Verona de Resende <verona.projects@tutanota.com>, Héber Hwang Arcolezi <heber.hwang-arcolezi@etsmtl.ca>
6
6
  License: MIT License
@@ -70,27 +70,45 @@ This repository provides a Python framework for **benchmarking fairness mechanis
70
70
 
71
71
  ## Installation
72
72
 
73
- > From source
74
- To install, either use PyPi to isntall it, or clone the repository and install dependencies:
73
+ First, we strongly recommend creating a new Python environment before installing the package. This helps maintain a clean and reproducible setup, facilitates dependency and version management and update, and minimises potential conflicts with previously installed libraries.
75
74
 
76
75
  ```bash
77
- git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
78
- cd dp-fair-intervention-benchmark
79
-
80
76
  python3 -m venv dpfair-env
81
- source dpfair-env/bin/activate
77
+ source dpfair-env/bin/activate # On Windows: dpfair-env\\Scripts\\activate
78
+ # Installation approach via PyPi or source installation
79
+ ```
82
80
 
81
+ If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
82
+ ```bash
83
83
  pip install torch --index-url https://download.pytorch.org/whl/cpu
84
- pip install -e .
85
84
  ```
86
85
 
87
- > Using PyPi **(SUGGESTED)**
86
+ Users on MacOS are required to install `llvm-openmp`, either using conda or brew, as below:
87
+
88
+ **Conda**:
89
+ ```bash
90
+ conda install -c conda-forge llvm-openmp
91
+ ```
92
+ **Brew**:
93
+ ```bash
94
+ brew install libomp
95
+ ```
96
+
97
+ Then, the library installation can proceed as per usual.
98
+
99
+ Our recommended method is via PyPI. With a Python 3.9+ and <3.13 environment:
100
+
88
101
  ```bash
89
- python3 -m venv dpfair-env
90
- source dpfair-env/bin/activate
91
- pip install torch --index-url https://download.pytorch.org/whl/cpu
92
102
  pip install BenchmarkDPFair
93
- ````
103
+ ```
104
+
105
+ Alternatively, there is the possibility to install from source, which also gives access to the `data/`, `example/`, and `notebook/` directories (be aware that these may consume more resources on your disk given the data provided):
106
+
107
+ ```bash
108
+ git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
109
+ cd dp-fair-intervention-benchmark
110
+ pip install -e .
111
+ ```
94
112
 
95
113
  ---
96
114
 
{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.6}/LICENSE RENAMED
File without changes