BenchmarkDPFair 0.2.5__tar.gz → 0.2.7__tar.gz

{benchmarkdpfair-0.2.5/src/BenchmarkDPFair.egg-info → benchmarkdpfair-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BenchmarkDPFair
-Version: 0.2.5
+Version: 0.2.7
 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,9 +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>=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: xgboost; sys_platform == "darwin"
+Requires-Dist: xgboost-cpu; sys_platform == "linux"
+Requires-Dist: xgboost-cpu; sys_platform == "win32"
 Requires-Dist: cvxpy>=1.6.5
 Requires-Dist: chex>=0.1.87
 Requires-Dist: BlackBoxAuditing==0.1.54
@@ -70,27 +70,52 @@ 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
+```
 
-pip install torch --index-url https://download.pytorch.org/whl/cpu
-pip install -e .
+
+When using Python 3.9, a specific version of the MBI library (`private-pgm`) must be installed by running the following command:
+
+```bash
+pip install git+https://github.com/ryan112358/private-pgm.git@01f02f17eba440f4e76c1d06fa5ee9eed0bd2bca
 ```
 
-> Using PyPi **(SUGGESTED)**
+If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
 ```bash
-python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
 pip install torch --index-url https://download.pytorch.org/whl/cpu
+```
+
+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
 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 .
+```
 
 ---
 

{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.7}/README.md

@@ -16,27 +16,52 @@ 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
+```
 
-pip install torch --index-url https://download.pytorch.org/whl/cpu
-pip install -e .
+
+When using Python 3.9, a specific version of the MBI library (`private-pgm`) must be installed by running the following command:
+
+```bash
+pip install git+https://github.com/ryan112358/private-pgm.git@01f02f17eba440f4e76c1d06fa5ee9eed0bd2bca
 ```
 
-> Using PyPi **(SUGGESTED)**
+If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
 ```bash
-python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
 pip install torch --index-url https://download.pytorch.org/whl/cpu
+```
+
+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
 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 .
+```
 
 ---
 

{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "BenchmarkDPFair"
-version = "0.2.5"
+version = "0.2.7"
 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,9 +27,9 @@ dependencies = [
   "smartnoise-synth>=1.0.5",
   "tabulate>=0.9.0",
   "ucimlrepo>=0.0.7",
-  "xgboost>=3.2.0; sys_platform == 'darwin'",
-  "xgboost-cpu>=3.2.0; sys_platform == 'linux'",
-  "xgboost-cpu>=3.2.0; sys_platform == 'win32'",
+  "xgboost; sys_platform == 'darwin'",
+  "xgboost-cpu; sys_platform == 'linux'",
+  "xgboost-cpu; sys_platform == 'win32'",
   "cvxpy>=1.6.5",
   "chex>=0.1.87",
   "BlackBoxAuditing==0.1.54"

{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.7/src/BenchmarkDPFair.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BenchmarkDPFair
-Version: 0.2.5
+Version: 0.2.7
 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,9 +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>=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: xgboost; sys_platform == "darwin"
+Requires-Dist: xgboost-cpu; sys_platform == "linux"
+Requires-Dist: xgboost-cpu; sys_platform == "win32"
 Requires-Dist: cvxpy>=1.6.5
 Requires-Dist: chex>=0.1.87
 Requires-Dist: BlackBoxAuditing==0.1.54
@@ -70,27 +70,52 @@ 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
+```
 
-pip install torch --index-url https://download.pytorch.org/whl/cpu
-pip install -e .
+
+When using Python 3.9, a specific version of the MBI library (`private-pgm`) must be installed by running the following command:
+
+```bash
+pip install git+https://github.com/ryan112358/private-pgm.git@01f02f17eba440f4e76c1d06fa5ee9eed0bd2bca
 ```
 
-> Using PyPi **(SUGGESTED)**
+If you are a Windows or Linux user, please install PyTorch CPU-only dependencies: [Step not required for Mac users]
 ```bash
-python3 -m venv dpfair-env
-source dpfair-env/bin/activate 
 pip install torch --index-url https://download.pytorch.org/whl/cpu
+```
+
+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
 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 .
+```
 
 ---
 

{benchmarkdpfair-0.2.5 → benchmarkdpfair-0.2.7}/src/BenchmarkDPFair.egg-info/requires.txt

@@ -17,10 +17,10 @@ chex>=0.1.87
 BlackBoxAuditing==0.1.54
 
 [:sys_platform == "darwin"]
-xgboost>=3.2.0
+xgboost
 
 [:sys_platform == "linux"]
-xgboost-cpu>=3.2.0
+xgboost-cpu
 
 [:sys_platform == "win32"]
-xgboost-cpu>=3.2.0
+xgboost-cpu