mmm-fair-cli 1.1.1

CLI-only version of the MMM-Fair boosting classifier

MMM-Fair-CLI

MMM-Fair-CLI is a lightweight, command-line-only version of the MMM-Fair framework for fairness-aware boosting. It excludes the web UI, LLMs, and chat features.

---

🔧 Installation

pip install mmm-fair-cli

Requires Python 3.12+.

Dependencies: numpy, scikit-learn, tqdm, pymoo, pandas, ucimlrepo, skl2onnx, etc.

---

🚀 Quick Usage (CLI)

python -m mmm_fair_cli.train_and_deploy \
  --classifier MMM_Fair_GBT \
  --dataset mydata.csv \
  --target label_col \
  --prots prot_1 prot_2 \
  --nprotgs npg1 npg2 \
  --constraint DP \
  --early_stop True \
  --n_learners 100 \
  --deploy pickle \
  --moo_vis True

With Known Dataset from Uciml repo

python -m mmm_fair_cli.train_and_deploy \
  --classifier MMM_Fair_GBT \
  --dataset Adult \
  --prots race sex \
  --nprotgs White Male \
  --constraint EO \
  --deploy onnx \
  --moo_vis True

---

Example Workflow

1. Choose Fairness Constraint: e.g., DP, EO, or EP.
2. Define sensitive attributes in saIndex and the protected-group condition in saValue.
3. Pick base learner (e.g., DecisionTreeClassifier(max_depth=5)) or gradient-based approach.
4. Train with a large number of estimators (n_estimators=300 or max_iter=300).
5. Optionally do partial ensemble selection with update_theta(criteria="all") or update_theta(criteria="fairness") .
6. Export to ONNX or pickle for downstream usage.
7. Use --moo_vis True to open local multi-objective 3D plots for deeper analysis.
8. Upload the .zip file (if exported to onnx) to MAMMOth for bias exploration.

---

Note:

1. Setting --moo_vis True triggers an interactive local HTML page for exploring the multi-objective trade-offs in 3D plots (accuracy vs. class-imbalance vs. fairness, etc.).
2. Currently the fairness intervention only implemented for categorical groups. So if protected attribute is numerical e.g. "age" then for non-protected value i.e. --nprotgs provide a range like 30_60 as argument.

---

Additional options

If you want to select the best theta from only the Pareto optimal ensembles set (default is False and selects applies the post-processing to all set of solutions):

--pareto True

If you want to provide test data:

--test 'your_test_file.csv'

Or just test split:

--test 0.3

If you want change style (default is table, choose from {table, console}) of report displayed (Check FairBench Library for more details):

--report_type Console

When deploying with 'onnx', we change the models to ONNX file(s), and store additional parameters in a model_params.npy. This gets zipped into a .zip archive for distribution/analysis.

---

MAMMOth Toolkit Integration

For the bias exploration using MAMMOth pipeline it is really important to select 'onnx' as the '--deploy' argument. The ONNX model accelerator and model_params.npy are used to integrate with the MAMMOth-toolkit or the demonstrator app from the mammoth-commons project.

🐍📓 From Notebook

from mmm_fair import MMM_Fair_GradientBoostedClassifier

clf = MMM_Fair_GradientBoostedClassifier(
    constraint="EO",        # or "DP", "EP"
    alpha=0.1,              # fairness weight
    saIndex=...,            # shape (n_samples, n_protected)
    saValue=...,            # dictionary or None
    max_iter=100,
    random_state=42,
    ## any other arguments that the HistGradientBoostingClassifier from sklearn can handle
)
clf.fit(X, y)
preds = clf.predict(X_test)

MMM-Fair includes utility functions to seamlessly work with datasets from the UCI Machine Learning Repository.

🔧 Load a UCI dataset (e.g. Adult dataset)

from mmm_fair import data_uci
from mmm_fair import build_sensitives

# Load dataset with target column
data = data_uci(dataset_name="Adult", target="income")

🛡️ Define Sensitive Attributes

saIndex, saValue = build_sensitives(
    data.data,
    protected_cols=["race", "sex"],
    non_protected_vals=["White", "Male"]
)

---

🤖 Need a Web UI or LLM Explanation?

👉 Use the full version: 🔗 https://pypi.org/project/mmm-fair/

Maintainer: Arjun Roy ([e-mail])

Contributors: Swati Swati ([e-mail]), Emmanoui Panagiotou ([e-mail])

🏛️ Funding

MMM-Fair is a research-driven project supported by several public funding initiatives. We gratefully acknowledge the generous support of:

                            

Volkswagen Foundation – BIAS     EU Horizon – MAMMOth     EU Horizon – STELAR

License & Contributing

This project is released under [Apache License Version 2.0]. Contributions are welcome—please open an issue or pull request on GitHub.

Contact

For questions or collaborations, please contact [e-mail] Check out the source code at: GITHUB.