mic-dp 0.1__py3-none-any.whl

mic_dp-0.1.dist-info/LICENSE

@@ -0,0 +1,5 @@
+MIT License
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy...

mic_dp-0.1.dist-info/METADATA

@@ -0,0 +1,160 @@
+Metadata-Version: 2.1
+Name: mic_dp
+Version: 0.1
+Summary: A Python package for maximum information coefficient differential privacy
+Home-page: https://github.com/uwtintres/mic-dp
+Author: Wenjun Yang, Eyhab Al-masri, Olivera Kotevska
+Author-email: wy927@uw.edu, ealmasri@uw.edu, kotevskao@ornl.gov
+Keywords: differential-privacy mic machine-learning privacy-preserving feature-selection
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Security :: Cryptography
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: diffprivlib
+Requires-Dist: scikit-learn
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: scipy
+Requires-Dist: lifelines
+Requires-Dist: statsmodels
+
+# MIC_DP: Maximum Information Coefficient Differential Privacy
+
+`mic_dp` is a Python package that enables differentially private data transformation guided by the *Maximum Information Coefficient* (MIC), with application to both supervised and unsupervised learning tasks. Traditional differential privacy (DP) mechanisms often degrade utility uniformly across features. In contrast, `mic_dp` uses MIC to scale the noise injection, preserving more utility in informative features.
+
+## Summary
+
+This package includes functions for:
+- Calculating MIC, Pearson, and Mahalanobis-based feature relevance
+- Feature selection based on scaled importance
+- Applying Gaussian or Laplace DP mechanisms using custom noise scaling
+- Evaluating MAE, clustering scores, and plotting results
+
+Our experiments show that MIC-guided DP mechanisms consistently outperform Pearson, Mahalanobis, and baseline DP in terms of feature and prediction accuracy under privacy constraints. In unsupervised settings, MIC-DP preserves cluster structures better, as shown by silhouette score, ARI, and V-measure.
+
+## Installation
+
+You can install the package directly from PyPI:
+
+```bash
+pip install micdp
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/merlery/mic_dp.git
+cd mic_dp
+pip install -e .
+```
+
+## Quick Start
+
+Here's a simple example of how to use `mic_dp` for supervised learning:
+
+```python
+import pandas as pd
+import numpy as np
+from sklearn.preprocessing import MinMaxScaler
+from mic_dp.core import (
+    noise_scaling_MIC, 
+    calculate_sensitivity, 
+    correlated_dp_gaussian,
+    mean_absolute_error
+)
+
+# Load and preprocess your data
+df = pd.read_csv('your_dataset.csv')
+df.dropna(inplace=True)
+X = df.select_dtypes(include=['number'])
+X_norm = pd.DataFrame(MinMaxScaler().fit_transform(X), columns=X.columns)
+y = df['target_column']  # Your target variable
+
+# Calculate MIC-based noise scaling factors
+noise_factors = noise_scaling_MIC(y, X_norm, amplification_factor=5)
+
+# Calculate sensitivity for each feature
+sensitivity = calculate_sensitivity(X_norm)
+
+# Apply differential privacy with MIC-guided noise scaling
+private_X = correlated_dp_gaussian(
+    X_norm.copy(), 
+    noise_factors, 
+    sensitivity, 
+    epsilon=0.5,  # Privacy budget
+    delta=1e-5    # Privacy relaxation parameter
+)
+
+# Evaluate the utility loss
+mae = mean_absolute_error(X_norm, private_X)
+print(f"Mean Absolute Error: {mae:.4f}")
+```
+
+## Detailed Example
+
+For a more comprehensive example, see the [supervised_experiment.py](examples/supervised_experiment.py) script, which demonstrates:
+
+1. Loading and preprocessing the Adult Census Income dataset
+2. Calculating feature relevance using MIC, Pearson, and Mahalanobis methods
+3. Applying differential privacy with different noise scaling strategies
+4. Evaluating and comparing the utility of each approach
+5. Visualizing the results
+
+To run the example:
+
+```bash
+python examples/supervised_experiment.py
+```
+
+## Experimental Results
+
+MIC-guided noise scaling consistently outperforms conventional approaches in preserving prediction accuracy and clustering structure under differential privacy constraints.
+
+![Feature MAE comparison for MIC-DP vs. state-of-art approaches](MAE.png)
+![Prediction MAE comparison for MIC-DP vs. state-of-art approaches](MAE_pred.png)
+
+## API Reference
+
+### Core Functions
+
+- `noise_scaling_MIC(target, features, factor)`: Calculate noise scaling factors based on Maximum Information Coefficient
+- `noise_scaling_pearson(target, features, factor)`: Calculate noise scaling factors based on Pearson correlation
+- `noise_scaling_mahalanobis_distances(target, features, factor)`: Calculate noise scaling factors based on Mahalanobis distances
+- `calculate_sensitivity(features)`: Calculate sensitivity for each feature based on its range
+- `correlated_dp_gaussian(X, noise_factors, sensitivity, epsilon, delta)`: Apply Gaussian differential privacy with custom noise scaling
+- `correlated_dp_laplace(X, noise_factors, sensitivity, epsilon, delta)`: Apply Laplace differential privacy with custom noise scaling
+- `feature_selection(percentage, X, noise_scaling_factor)`: Select features based on their noise scaling factors
+- `mean_absolute_error(y_true, y_pred)`: Calculate mean absolute error between true and predicted values
+- `cluster_and_evaluate(df, name, n_clusters)`: Perform clustering and evaluate the results
+- `calculate_ari(labels1, labels2)`: Calculate Adjusted Rand Index between two cluster labelings
+- `calculate_v_measure(labels1, labels2)`: Calculate V-measure between two cluster labelings
+
+## Citation
+
+If you use this package in your research, please cite:
+
+```
+@article{yang2025micdp,
+  title={mic\_dp: A Python package for maximum information coefficient differential privacy},
+  author={Yang, Wenjun and Al-masri, Eyhab and Kotevska, Olivera},
+  journal={Journal of Open Source Software},
+  year={2025}
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgements
+
+We acknowledge the creators of the ACI and HED datasets for making their data publicly available.
+
+## References

mic_dp-0.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+mic_dp-0.1.dist-info/LICENSE,sha256=fU6gYh2_CWA-FiM2tHIUUzp-Z5yc-Pz11k1vVDL0CSY,113
+mic_dp-0.1.dist-info/METADATA,sha256=1bYzU5WxwyA-KDGtlrdPQl17OJ8JLpCt0RVJSojWjpo,6293
+mic_dp-0.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+mic_dp-0.1.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+mic_dp-0.1.dist-info/RECORD,,

mic_dp-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (72.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mic_dp-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+