aibt-fl 1.0.0__py3-none-any.whl

aibt_fl-1.0.0.dist-info/METADATA

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: aibt-fl
+Version: 1.0.0
+Summary: AIBT: Adversarial Information Bottleneck Training for Privacy-Preserving Federated Learning
+Author-email: AIBT Research Team <aibt@example.com>
+Maintainer-email: AIBT Research Team <aibt@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/aibt/aibt
+Project-URL: Documentation, https://aibt.readthedocs.io
+Project-URL: Repository, https://github.com/aibt/aibt
+Project-URL: Issues, https://github.com/aibt/aibt/issues
+Project-URL: Changelog, https://github.com/aibt/aibt/blob/main/CHANGELOG.md
+Keywords: federated-learning,privacy-preserving,machine-learning,deep-learning,adversarial-training,information-bottleneck,pytorch,neural-networks,differential-privacy,secure-aggregation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=1.9.0
+Requires-Dist: numpy>=1.19.0
+Requires-Dist: scikit-learn>=0.24.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: isort>=5.0; extra == "dev"
+Requires-Dist: flake8>=4.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
+Dynamic: license-file
+
+# AIBT: Adversarial Information Bottleneck Training
+
+[![PyPI version](https://badge.fury.io/py/aibt-fl.svg)](https://badge.fury.io/py/aibt-fl)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![PyTorch](https://img.shields.io/badge/PyTorch-1.9+-red.svg)](https://pytorch.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> Privacy-preserving federated learning with information-theoretic privacy guarantees
+
+## Overview
+
+**AIBT** (Adversarial Information Bottleneck Training) is a privacy-preserving federated learning framework that combines information bottleneck theory with adversarial training to achieve strong privacy guarantees while maintaining high model utility.
+
+### Key Features
+
+- 🔒 **Privacy-Preserving**: Combines Information Bottleneck (IB) with adversarial training
+- 🌐 **Federated Learning**: Distributed training with FedAvg aggregation
+- 🛡️ **Attack Resistant**: Defends against Membership and Attribute Inference attacks
+- 🚀 **Easy to Use**: Simple API for training and evaluation
+- 📊 **Built-in Metrics**: Privacy attack evaluation included
+
+## Installation
+
+```bash
+pip install aibt-fl
+```
+
+### From Source
+
+```bash
+git clone https://github.com/aibt/aibt.git
+cd aibt/aibt_package
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import torch
+from aibt import AIBTFL, AIBTModel, create_aibt_model, evaluate_privacy
+
+# Create an AIBT model for your data
+model = create_aibt_model(
+    input_dim=13,           # Number of input features
+    num_classes=2,          # Number of output classes
+    latent_dim=64,          # Latent space dimension
+    num_sensitive_classes=2 # Number of sensitive attribute classes
+)
+
+# Initialize AIBT Federated Learning
+aibt = AIBTFL(
+    model=model,
+    num_clients=10,
+    device="cpu",
+    learning_rate=0.001,
+    lambda_kl=0.01,     # KL divergence weight (Information Bottleneck)
+    lambda_adv=1.0,     # Adversarial loss weight
+)
+
+# Setup clients with their data
+aibt.setup_clients(
+    client_datasets=client_data,        # List of (X, y) tuples per client
+    sensitive_data=client_sensitive     # Optional: sensitive attributes
+)
+
+# Train with federated learning
+history = aibt.train(
+    num_rounds=100,
+    local_epochs=5,
+    test_data=(X_test, y_test),
+    verbose=True
+)
+
+# Evaluate privacy
+privacy_metrics = evaluate_privacy(
+    model=model,
+    train_data=(X_train, y_train),
+    test_data=(X_test, y_test),
+    device="cpu"
+)
+
+print(f"Membership Inference AUC: {privacy_metrics['membership_auc']:.4f}")
+print(f"Privacy preserved: {privacy_metrics['membership_auc'] < 0.55}")
+```
+
+## Architecture
+
+AIBT combines three key components:
+
+```
+Input → Encoder → Compressed Representation → Predictor → Output
+                         ↓
+                    Adversary (tries to infer sensitive info)
+                         ↓
+                  Gradient Reversal Layer
+```
+
+**Loss Function:**
+```
+L = L_task + λ₁ L_KL - λ₂ L_adv
+```
+
+- `L_task`: Task-specific loss (e.g., cross-entropy)
+- `L_KL`: KL divergence for information bottleneck compression
+- `L_adv`: Adversarial loss for privacy (with gradient reversal)
+
+## API Reference
+
+### Core Classes
+
+#### `AIBTFL`
+Main federated learning class with AIBT training.
+
+```python
+AIBTFL(
+    model,                      # AIBTModel instance
+    num_clients=10,             # Number of federated clients
+    device="cpu",               # Device (cpu/cuda)
+    learning_rate=0.001,        # Learning rate
+    batch_size=32,              # Batch size
+    lambda_kl=0.01,             # KL divergence weight
+    lambda_adv=1.0,             # Adversarial loss weight
+    lambda_grl=1.0,             # Gradient reversal strength
+)
+```
+
+#### `AIBTModel`
+Complete AIBT model with encoder, predictor, and adversary.
+
+```python
+AIBTModel(
+    encoder,            # Encoder network
+    predictor,          # Task predictor
+    adversary,          # Adversary network
+    lambda_kl=0.01,     # KL weight
+    lambda_adv=1.0,     # Adversarial weight
+    lambda_grl=1.0,     # GRL strength
+)
+```
+
+### Model Components
+
+- `GradientReversalLayer`: Reverses gradients during backprop for adversarial training
+- `VariationalEncoder`: Information bottleneck encoder with reparameterization
+- `MLPEncoder`: MLP encoder for tabular data
+- `Predictor`: Task prediction head
+- `Adversary`: Sensitive attribute classifier
+
+### Privacy Metrics
+
+```python
+from aibt import evaluate_privacy, evaluate_membership_inference, evaluate_attribute_inference
+
+# Complete privacy evaluation
+metrics = evaluate_privacy(model, train_data, test_data, sensitive_train, sensitive_test)
+
+# Individual attacks
+mia_metrics = evaluate_membership_inference(model, train_data, test_data)
+aia_metrics = evaluate_attribute_inference(model, X, sensitive_attrs)
+```
+
+## Hyperparameters
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `lambda_kl` | 0.01 | KL divergence weight (compression) |
+| `lambda_adv` | 1.0 | Adversarial loss weight (privacy) |
+| `lambda_grl` | 1.0 | Gradient reversal strength |
+| `latent_dim` | 128 | Latent space dimension |
+| `learning_rate` | 0.001 | Optimizer learning rate |
+| `batch_size` | 32 | Training batch size |
+
+### Hyperparameter Tuning
+
+- **Higher `lambda_kl`**: More compression, potentially lower accuracy
+- **Higher `lambda_adv`**: Stronger privacy, may affect utility
+- **Recommended range**: `lambda_kl ∈ [0.005, 0.02]`, `lambda_adv ∈ [0.5, 2.0]`
+
+## Citation
+
+If you use AIBT in your research, please cite:
+
+```bibtex
+@article{aibt2025,
+  title={Adversarial Information Bottleneck Training for Privacy-Preserving Federated Learning},
+  journal={IEEE Transactions on Neural Networks and Learning Systems},
+  year={2025}
+}
+```
+
+## References
+
+- Tishby et al., "The Information Bottleneck Method", Allerton 1999
+- Ganin & Lempitsky, "Domain-Adversarial Training of Neural Networks", JMLR 2016
+- McMahan et al., "Communication-Efficient Learning of Deep Networks from Decentralized Data", AISTATS 2017
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

aibt_fl-1.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+aibt/__init__.py,sha256=zFLXOiDrNTT4mcZdJxn51P9r66-TvEDF0I__9rmv0As,1973
+aibt/aggregation.py,sha256=NwtAKKTwOGhxka_V_rgA-7wzg1auwRRFDKifrgmBkP4,1873
+aibt/client.py,sha256=KH4KKNLMQ4EPoAvE4m7cps23Sj6R2huiSaBmG1iyY_M,8370
+aibt/core.py,sha256=26YgiQiS2ccNjpF2HG_2ILehUXxqGab-BWmCQkN9icg,10409
+aibt/metrics.py,sha256=BUlmpZGVarwl1rmCd-vW4AELF_zKlSlHOjXniHJIfbM,13019
+aibt/models.py,sha256=xZmUi04ohZ9GbYw9KES_ebcBj5HBjPs-1eMXwaKIqqY,16215
+aibt/py.typed,sha256=a5K6xx9qkO2ovz5hHopVYtLfXXtb1or--wJahADDHGU,87
+aibt/utils.py,sha256=xVznSZWaLU5hO-MJi7VdacclcAz4qIn7X6ZwnyBLEL4,4026
+aibt_fl-1.0.0.dist-info/licenses/LICENSE,sha256=Mu9ua711JBvrfP99dUNRoELBtzhdtQJsstlyLprYxws,1096
+aibt_fl-1.0.0.dist-info/METADATA,sha256=j7-Gi-JGSnez1pPluKa0ykVoNMnwxO-XFXx_SmCks7U,8552
+aibt_fl-1.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+aibt_fl-1.0.0.dist-info/top_level.txt,sha256=3xRK-_2gN4esOyiSWpisUQmkbcMXAbYNYSTP_HDgk0E,5
+aibt_fl-1.0.0.dist-info/RECORD,,

aibt_fl-1.0.0.dist-info/WHEEL

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

aibt_fl-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AIBT Research Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aibt_fl-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+aibt