BenchmarkDPFair 0.2.4__tar.gz → 0.2.6__tar.gz

{benchmarkdpfair-0.2.4/src/BenchmarkDPFair.egg-info → benchmarkdpfair-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BenchmarkDPFair
-Version: 0.2.4
+Version: 0.2.6
 Summary: A differentially private data synthesizer and fairness intervention benchmark framework
 Author-email: Vinicius Gabriel Angelozzi Verona de Resende <verona.projects@tutanota.com>, Héber Hwang Arcolezi <heber.hwang-arcolezi@etsmtl.ca>
 License: MIT License
@@ -44,7 +44,9 @@ Requires-Dist: smartnoise-sql>=1.0.6
 Requires-Dist: smartnoise-synth>=1.0.5
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: ucimlrepo>=0.0.7
-Requires-Dist: xgboost-cpu>=3.2.0
+Requires-Dist: xgboost>=3.2.0; sys_platform == "darwin"
+Requires-Dist: xgboost-cpu>=3.2.0; sys_platform == "linux"
+Requires-Dist: xgboost-cpu>=3.2.0; sys_platform == "win32"
 Requires-Dist: cvxpy>=1.6.5
 Requires-Dist: chex>=0.1.87
 Requires-Dist: BlackBoxAuditing==0.1.54
@@ -68,27 +70,45 @@ This repository provides a Python framework for **benchmarking fairness mechanis
 
 ## Installation
 
-> From source
-To install, either use PyPi to isntall it, or clone the repository and install dependencies:
+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.
 
 ```bash
-git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
-cd dp-fair-intervention-benchmark
-
 python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
+source dpfair-env/bin/activate   # On Windows: dpfair-env\\Scripts\\activate
+# Installation approach via PyPi or source installation
+```
 
+If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
+```bash
 pip install torch --index-url https://download.pytorch.org/whl/cpu
-pip install -e .
 ```
 
-> Using PyPi **(SUGGESTED)**
+Users on MacOS are required to install `llvm-openmp`, either using conda or brew, as below:
+
+**Conda**:
+```bash
+conda install -c conda-forge llvm-openmp
+```
+**Brew**:
+```bash
+brew install libomp
+```
+
+Then, the library installation can proceed as per usual.
+
+Our recommended method is via PyPI. With a Python 3.9+ and <3.13 environment:
+
 ```bash
-python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
-pip install torch --index-url https://download.pytorch.org/whl/cpu
 pip install BenchmarkDPFair
-````
+```
+
+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):
+
+```bash
+git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
+cd dp-fair-intervention-benchmark
+pip install -e .
+```
 
 ---
 
@@ -97,8 +117,7 @@ pip install BenchmarkDPFair
 ```
 ├── data/         # Pre-offered datasets
 ├── src/          # Core source code
-├── examples/     # Some demo
-├── tests/        # Unit tests
+├── example/      # Files used in the main paper and a dummy example.
 └── README.md
 ```
 

{benchmarkdpfair-0.2.4 → benchmarkdpfair-0.2.6}/README.md

@@ -16,27 +16,45 @@ This repository provides a Python framework for **benchmarking fairness mechanis
 
 ## Installation
 
-> From source
-To install, either use PyPi to isntall it, or clone the repository and install dependencies:
+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.
 
 ```bash
-git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
-cd dp-fair-intervention-benchmark
-
 python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
+source dpfair-env/bin/activate   # On Windows: dpfair-env\\Scripts\\activate
+# Installation approach via PyPi or source installation
+```
 
+If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
+```bash
 pip install torch --index-url https://download.pytorch.org/whl/cpu
-pip install -e .
 ```
 
-> Using PyPi **(SUGGESTED)**
+Users on MacOS are required to install `llvm-openmp`, either using conda or brew, as below:
+
+**Conda**:
+```bash
+conda install -c conda-forge llvm-openmp
+```
+**Brew**:
+```bash
+brew install libomp
+```
+
+Then, the library installation can proceed as per usual.
+
+Our recommended method is via PyPI. With a Python 3.9+ and <3.13 environment:
+
 ```bash
-python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
-pip install torch --index-url https://download.pytorch.org/whl/cpu
 pip install BenchmarkDPFair
-````
+```
+
+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):
+
+```bash
+git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
+cd dp-fair-intervention-benchmark
+pip install -e .
+```
 
 ---
 
@@ -45,8 +63,7 @@ pip install BenchmarkDPFair
 ```
 ├── data/         # Pre-offered datasets
 ├── src/          # Core source code
-├── examples/     # Some demo
-├── tests/        # Unit tests
+├── example/      # Files used in the main paper and a dummy example.
 └── README.md
 ```
 

{benchmarkdpfair-0.2.4 → benchmarkdpfair-0.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "BenchmarkDPFair"
-version = "0.2.4"
+version = "0.2.6"
 description = "A differentially private data synthesizer and fairness intervention benchmark framework"
 authors = [
   { name="Vinicius Gabriel Angelozzi Verona de Resende", email="verona.projects@tutanota.com" },
@@ -27,7 +27,9 @@ dependencies = [
   "smartnoise-synth>=1.0.5",
   "tabulate>=0.9.0",
   "ucimlrepo>=0.0.7",
-  "xgboost-cpu>=3.2.0",
+  "xgboost>=3.2.0; sys_platform == 'darwin'",
+  "xgboost-cpu>=3.2.0; sys_platform == 'linux'",
+  "xgboost-cpu>=3.2.0; sys_platform == 'win32'",
   "cvxpy>=1.6.5",
   "chex>=0.1.87",
   "BlackBoxAuditing==0.1.54"

{benchmarkdpfair-0.2.4 → benchmarkdpfair-0.2.6/src/BenchmarkDPFair.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BenchmarkDPFair
-Version: 0.2.4
+Version: 0.2.6
 Summary: A differentially private data synthesizer and fairness intervention benchmark framework
 Author-email: Vinicius Gabriel Angelozzi Verona de Resende <verona.projects@tutanota.com>, Héber Hwang Arcolezi <heber.hwang-arcolezi@etsmtl.ca>
 License: MIT License
@@ -44,7 +44,9 @@ Requires-Dist: smartnoise-sql>=1.0.6
 Requires-Dist: smartnoise-synth>=1.0.5
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: ucimlrepo>=0.0.7
-Requires-Dist: xgboost-cpu>=3.2.0
+Requires-Dist: xgboost>=3.2.0; sys_platform == "darwin"
+Requires-Dist: xgboost-cpu>=3.2.0; sys_platform == "linux"
+Requires-Dist: xgboost-cpu>=3.2.0; sys_platform == "win32"
 Requires-Dist: cvxpy>=1.6.5
 Requires-Dist: chex>=0.1.87
 Requires-Dist: BlackBoxAuditing==0.1.54
@@ -68,27 +70,45 @@ This repository provides a Python framework for **benchmarking fairness mechanis
 
 ## Installation
 
-> From source
-To install, either use PyPi to isntall it, or clone the repository and install dependencies:
+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.
 
 ```bash
-git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
-cd dp-fair-intervention-benchmark
-
 python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
+source dpfair-env/bin/activate   # On Windows: dpfair-env\\Scripts\\activate
+# Installation approach via PyPi or source installation
+```
 
+If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
+```bash
 pip install torch --index-url https://download.pytorch.org/whl/cpu
-pip install -e .
 ```
 
-> Using PyPi **(SUGGESTED)**
+Users on MacOS are required to install `llvm-openmp`, either using conda or brew, as below:
+
+**Conda**:
+```bash
+conda install -c conda-forge llvm-openmp
+```
+**Brew**:
+```bash
+brew install libomp
+```
+
+Then, the library installation can proceed as per usual.
+
+Our recommended method is via PyPI. With a Python 3.9+ and <3.13 environment:
+
 ```bash
-python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
-pip install torch --index-url https://download.pytorch.org/whl/cpu
 pip install BenchmarkDPFair
-````
+```
+
+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):
+
+```bash
+git clone https://github.com/vinicius-verona/dp-fair-intervention-benchmark.git
+cd dp-fair-intervention-benchmark
+pip install -e .
+```
 
 ---
 
@@ -97,8 +117,7 @@ pip install BenchmarkDPFair
 ```
 ├── data/         # Pre-offered datasets
 ├── src/          # Core source code
-├── examples/     # Some demo
-├── tests/        # Unit tests
+├── example/      # Files used in the main paper and a dummy example.
 └── README.md
 ```
 

{benchmarkdpfair-0.2.4 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair.egg-info/SOURCES.txt

@@ -21,7 +21,4 @@ src/BenchmarkDPFair/Benchmark/utils/verifiers.py
 src/BenchmarkDPFair/DataGenerator/__init__.py
 src/BenchmarkDPFair/DataGenerator/dataconf.py
 src/BenchmarkDPFair/DataGenerator/datagen.py
-src/BenchmarkDPFair/DataGenerator/utils/verifiers.py
-tests/test_benchmark.py
-tests/test_dataconf.py
-tests/test_datagen.py
+src/BenchmarkDPFair/DataGenerator/utils/verifiers.py

{benchmarkdpfair-0.2.4 → benchmarkdpfair-0.2.6}/src/BenchmarkDPFair.egg-info/requires.txt

@@ -12,7 +12,15 @@ smartnoise-sql>=1.0.6
 smartnoise-synth>=1.0.5
 tabulate>=0.9.0
 ucimlrepo>=0.0.7
-xgboost-cpu>=3.2.0
 cvxpy>=1.6.5
 chex>=0.1.87
 BlackBoxAuditing==0.1.54
+
+[:sys_platform == "darwin"]
+xgboost>=3.2.0
+
+[:sys_platform == "linux"]
+xgboost-cpu>=3.2.0
+
+[:sys_platform == "win32"]
+xgboost-cpu>=3.2.0

benchmarkdpfair-0.2.4/tests/test_benchmark.py

@@ -1,31 +0,0 @@
-import sys
-from pathlib import Path
-
-# Add src/ to the Python path
-sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "src"))
-
-from Benchmark.dataconf import DatasetConfig
-
-
-# Test DatsetConfig object creation
-
-def test_dataset_config():
-
-    adult = DatasetConfig(
-        name="Adult",
-        target="income",   
-        root_dir="../data/",
-        sensitive_attr="sex",
-        categorical_cols=['workclass', 'education', 'marital-status', 'occupation', 'relationship', 'race', 'sex', 'native-country', 'income', 'age', 'hours-per-week'],
-        usecols = [
-            'age', 'native-country', 'education', 'marital-status', 'occupation', 'relationship',
-            'hours-per-week', 'workclass', 'race', 'sex', 'income'
-        ] 
-    )
-
-    x = str(adult)
-    assert x ==  "DatasetConfig(name=Adult,dir=../data/,target=income,sensitive_attr=sex,categorical_cols=['workclass', 'education', 'marital-status', 'occupation', 'relationship', 'race', 'sex', 'native-country', 'income', 'age', 'hours-per-week'],ordinal_cols=[],continuous_cols=[])"
-
-
-if __name__ == "__main__":
-    test_dataset_config()

benchmarkdpfair-0.2.4/tests/test_dataconf.py

@@ -1,25 +0,0 @@
-from Benchmark.dataconf import BenchmarkDatasetConfig
-
-
-# Test DatsetConfig object creation
-
-def test_dataset_config():
-
-    adult = BenchmarkDatasetConfig(
-        name="Adult",
-        target="income",   
-        root_dir="../data/",
-        sensitive_attr="sex",
-        categorical_cols=['workclass', 'education', 'marital-status', 'occupation', 'relationship', 'race', 'sex', 'native-country', 'income', 'age', 'hours-per-week'],
-        usecols = [
-            'age', 'native-country', 'education', 'marital-status', 'occupation', 'relationship',
-            'hours-per-week', 'workclass', 'race', 'sex', 'income'
-        ] 
-    )
-
-    x = str(adult)
-    assert x ==  "BenchmarkDatasetConfig(name=Adult,dir=../data/,target=income,sensitive_attr=sex,categorical_cols=['workclass', 'education', 'marital-status', 'occupation', 'relationship', 'race', 'sex', 'native-country', 'income', 'age', 'hours-per-week'],ordinal_cols=[],continuous_cols=[])"
-
-
-if __name__ == "__main__":
-    test_dataset_config()