humancompatible-detect 0.1.4__tar.gz

humancompatible_detect-0.1.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

humancompatible_detect-0.1.4/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: humancompatible-detect
+Version: 0.1.4
+Summary: A Python Toolkit for Detecting Bias in AI Models
+Author: Germán Martínez Matilla, Illia Kryvoviaz, Jakub Mareček, Jiří Němeček
+Maintainer-email: Illia Kryvoviaz <illiakryvoviaz@gmail.com>, Jiří Němeček <nemecj38@fel.cvut.cz>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/humancompatible/detect
+Project-URL: Documentation, https://humancompatible-detect.readthedocs.io/en/latest
+Project-URL: Issues, https://github.com/humancompatible/detect/issues
+Keywords: toolkit,fairness,bias,ai,ml,subgroup,intersectional,msd,linf,optimization,milp,pyomo,highs,gurobi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3.0,>=2.2
+Requires-Dist: pandas<3.0,>=2.2
+Requires-Dist: pyomo<7.0,>=6.9
+Requires-Dist: highspy<2.0,>=1.10
+Requires-Dist: scipy<2.0,>=1.16
+Requires-Dist: tqdm<5.0,>=4.6
+Provides-Extra: gurobi
+Requires-Dist: gurobipy<13.0,>=12.0; extra == "gurobi"
+Provides-Extra: cplex
+Requires-Dist: cplex<23.0,>=22.1.2.0; extra == "cplex"
+Provides-Extra: xpress
+Requires-Dist: xpress<10.0,>=9.8.0; extra == "xpress"
+Provides-Extra: examples
+Requires-Dist: jupyterlab<5.0,>=4.2; extra == "examples"
+Requires-Dist: matplotlib<4.0,>=3.10; extra == "examples"
+Requires-Dist: folktables<0.1,>=0.0.12; extra == "examples"
+Provides-Extra: docs
+Requires-Dist: sphinx<8.0,>=7.0; extra == "docs"
+Requires-Dist: myst-parser<4.0,>=3.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme<3.0,>=2.0; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest<9.0,>=8.0; extra == "dev"
+Requires-Dist: ruff<0.7,>=0.6; extra == "dev"
+Requires-Dist: black<25.0,>=24.8; extra == "dev"
+Requires-Dist: build<2.0,>=1.2; extra == "dev"
+Requires-Dist: twine<6.0,>=5.0; extra == "dev"
+Dynamic: license-file
+
+# humancompatible.detect
+
+[![Docs](https://readthedocs.org/projects/humancompatible-detect/badge/?version=latest)](https://humancompatible-detect.readthedocs.io/en/latest)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Pypi](https://img.shields.io/pypi/v/humancompatible-detect)](https://pypi.org/project/humancompatible-detect/)
+
+humancompatible.detect is an open-source toolkit for detecting bias in AI models and their training data.
+
+## AI Fairness
+
+In fairness auditing, one would generally like to know if two distributions are identical.
+These distributions could be a distribution of internal private training data and publicly accessible data from a nationwide census, i.e., a good baseline.
+Or one can compare samples classified positively and negatively, to see if groups are represented equally in each class.
+
+In other words, we ask
+
+> Is there _some_ combination of protected attributes (race × age × …) for which people are treated noticeably differently?
+
+A set of samples belonging to a given combination of protected attributes is called a subgroup.
+
+<!-- Formally, let
+
+* **X** ∈ ℝ<sup>d</sup> be the feature space,
+* **P** and **Q** two distributions we want to compare (e.g. training vs census, positives vs negatives),
+* **𝒫** ⊂ {1,…,d} the indices of *protected* features (age, sex, race, …).
+
+A **sub-group** *S* is all samples whose protected attributes take one fixed value each.
+We must consider every such intersection -- their number is exponential in |𝒫|.
+ -->
+
+## Using HumanCompatible.Detect
+
+1. Install the library (in a virtual environment if desired):
+   ```bash
+   pip install humancompatible-detect
+   ```
+2. Compute the bias ([MSD](#maximum-subgroup-discrepancy-msd) in this case):
+
+   ```python
+   from humancompatible.detect import detect_and_score
+
+   # toy example
+   # (col 1 = Race, col 2 = Age, col 3 = (binary) target)
+   rule_idx, msd = detect_and_score(
+       csv_path = "./data/01_data.csv",
+       target_col = "Target",
+       protected_list = ["Race", "Age"],
+       method = "MSD",
+   )
+   ```
+
+### More to explore
+
+- [`examples/01_basic_usage.ipynb`](https://github.com/humancompatible/detect/blob/main/examples/01_basic_usage.ipynb) -- a 5-minute notebook reproducing the call above, then translating `rule_idx` back to human-readable conditions.
+- [`examples/02_folktables_within-state.ipynb`](https://github.com/humancompatible/detect/blob/main/examples/02_folktables_within-state.ipynb) -- a realistic Folktables/ACS Income example that runs MSD within a single state, reports the most affected subgroup, and interprets the signed gap.
+- More notebooks live in [`examples/`](https://github.com/humancompatible/detect/tree/main/examples), new ones being added over time.
+
+Feel free to start with the light notebook, then dive into the experiments with different datasets.
+
+We also provide [documentation](https://humancompatible-detect.readthedocs.io/en/latest). For more details on installation, see [Installation details](#installation-details).
+
+---
+
+## Methods
+
+### Maximum Subgroup Discrepancy (MSD)
+
+MSD is the subgroup maximal difference in probability mass of a given subgroup, comparing the mass given by each distribution.
+
+<!-- ```math
+
+\text{MSD}(P,Q;\,𝒫)=
+\max_{S\;\text{sub-group on }𝒫}\;
+\bigl|\;P(S)-Q(S)\;\bigr|.
+
+``` -->
+
+- Naturally, two distributions are _fair_ iff all subgroups have similar mass.
+- The **arg max** immediately tells you _which_ group is most disadvantaged as an interpretable attribute-value combination.
+- MSD has linear sample complexity, a stark contrast to exponential complexity of other distributional distances (Wasserstein, TV...)
+
+### Subsampled ℓ∞ norm
+
+This method checks in a very efficient way whether the bias in any subgroup exceeds a given threshold. That is, it tells us to which extent, a particular subgroup obtains the positive outcome more or less frequently than the general trend in the dataset. Here, the fact that we can perform a subsampling with guaranties is key. It is the method of choice in cases in which one wants to be sure that a given dataset is compliant with a predefined acceptable bias level for all its subgroups.
+
+---
+
+## Installation details
+
+### Requirements
+
+All Python dependencies are declared in pyproject.toml (core + optional extras).
+
+- **Python ≥ 3.10**
+
+- **A MILP solver** (required for MSD).
+  > We use [Pyomo](https://pyomo.readthedocs.io/) for modelling. This allows for multiple solvers, see the lists of [solver interfaces](https://pyomo.readthedocs.io/en/stable/reference/topical/solvers/index.html) and [persistent solver interfaces](https://pyomo.readthedocs.io/en/stable/reference/topical/appsi/appsi.html).
+
+  - Default (recommended): HiGHS -- works out of the box because we install the HiGHS Python bindings (highspy) with the package.
+
+  - Optional commercial solvers (license required): Gurobi / CPLEX / Xpress
+  These require a valid installation + license from the vendor. (Some also have free community license, and pip-installable Python APIs.)
+
+  - Optional open-source fallback: GLPK requires the glpsol executable on your system PATH.
+
+- Other dependencies (installed automatically): numpy, pandas, scipy, pyomo, tqdm, etc.
+
+### (Optional) create a fresh environment
+
+```bash
+python -m venv .venv
+# Activate it
+source .venv/bin/activate     # Linux / macOS
+.venv\Scripts\activate.bat    # Windows -- cmd.exe
+.venv\Scripts\Activate.ps1    # Windows -- PowerShell
+```
+
+### Install the package
+
+```bash
+python -m pip install humancompatible-detect
+```
+
+### Optional extras
+
+To install with optional commercial solvers:
+
+```bash
+python -m pip install "humancompatible-detect[gurobi]"
+python -m pip install "humancompatible-detect[cplex]"
+python -m pip install "humancompatible-detect[xpress]"
+```
+
+Or if you want the notebooks + plotting dependencies:
+
+```bash
+python -m pip install "humancompatible-detect[examples]"
+```
+
+And if docs/dev dependencies are desired:
+
+```bash
+python -m pip install "humancompatible-detect[docs]"
+python -m pip install "humancompatible-detect[dev]"
+```
+
+### Verify it worked
+
+```bash
+python -c "from humancompatible.detect import detect_and_score; print('detect imported OK')"
+```
+
+If the import fails you'll see:
+
+```bash
+ModuleNotFoundError: No module named 'humancompatible'
+```
+
+---
+
+## References
+
+If you use the MSD in your work, please cite the following work:
+
+```bibtex
+@inproceedings{MSD,
+  author = {N\v{e}me\v{c}ek, Ji\v{r}\'{\i} and Kozdoba, Mark and Kryvoviaz, Illia and Pevn\'{y}, Tom\'{a}\v{s} and Mare\v{c}ek, Jakub},
+  title = {Bias Detection via Maximum Subgroup Discrepancy},
+  year = {2025},
+  isbn = {9798400714542},
+  publisher = {Association for Computing Machinery},
+  address = {New York, NY, USA},
+  url = {https://doi.org/10.1145/3711896.3736857},
+  doi = {10.1145/3711896.3736857},
+  booktitle = {Proceedings of the 31st ACM SIGKDD Conference on Knowledge Discovery and Data Mining V.2},
+  pages = {2174–2185},
+  numpages = {12},
+  location = {Toronto ON, Canada},
+  series = {KDD '25}
+}
+```
+
+If you used the ℓ∞ method, please cite:
+
+```bibtex
+@misc{matilla2025samplecomplexitybiasdetection,
+      title={Sample Complexity of Bias Detection with Subsampled Point-to-Subspace Distances},
+      author={M. Matilla, Germán and Mareček, Jakub},
+      year={2025},
+      eprint={2502.02623},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG},
+      url={https://arxiv.org/abs/2502.02623v1},
+}
+```

humancompatible_detect-0.1.4/README.md

@@ -0,0 +1,195 @@
+# humancompatible.detect
+
+[![Docs](https://readthedocs.org/projects/humancompatible-detect/badge/?version=latest)](https://humancompatible-detect.readthedocs.io/en/latest)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Pypi](https://img.shields.io/pypi/v/humancompatible-detect)](https://pypi.org/project/humancompatible-detect/)
+
+humancompatible.detect is an open-source toolkit for detecting bias in AI models and their training data.
+
+## AI Fairness
+
+In fairness auditing, one would generally like to know if two distributions are identical.
+These distributions could be a distribution of internal private training data and publicly accessible data from a nationwide census, i.e., a good baseline.
+Or one can compare samples classified positively and negatively, to see if groups are represented equally in each class.
+
+In other words, we ask
+
+> Is there _some_ combination of protected attributes (race × age × …) for which people are treated noticeably differently?
+
+A set of samples belonging to a given combination of protected attributes is called a subgroup.
+
+<!-- Formally, let
+
+* **X** ∈ ℝ<sup>d</sup> be the feature space,
+* **P** and **Q** two distributions we want to compare (e.g. training vs census, positives vs negatives),
+* **𝒫** ⊂ {1,…,d} the indices of *protected* features (age, sex, race, …).
+
+A **sub-group** *S* is all samples whose protected attributes take one fixed value each.
+We must consider every such intersection -- their number is exponential in |𝒫|.
+ -->
+
+## Using HumanCompatible.Detect
+
+1. Install the library (in a virtual environment if desired):
+   ```bash
+   pip install humancompatible-detect
+   ```
+2. Compute the bias ([MSD](#maximum-subgroup-discrepancy-msd) in this case):
+
+   ```python
+   from humancompatible.detect import detect_and_score
+
+   # toy example
+   # (col 1 = Race, col 2 = Age, col 3 = (binary) target)
+   rule_idx, msd = detect_and_score(
+       csv_path = "./data/01_data.csv",
+       target_col = "Target",
+       protected_list = ["Race", "Age"],
+       method = "MSD",
+   )
+   ```
+
+### More to explore
+
+- [`examples/01_basic_usage.ipynb`](https://github.com/humancompatible/detect/blob/main/examples/01_basic_usage.ipynb) -- a 5-minute notebook reproducing the call above, then translating `rule_idx` back to human-readable conditions.
+- [`examples/02_folktables_within-state.ipynb`](https://github.com/humancompatible/detect/blob/main/examples/02_folktables_within-state.ipynb) -- a realistic Folktables/ACS Income example that runs MSD within a single state, reports the most affected subgroup, and interprets the signed gap.
+- More notebooks live in [`examples/`](https://github.com/humancompatible/detect/tree/main/examples), new ones being added over time.
+
+Feel free to start with the light notebook, then dive into the experiments with different datasets.
+
+We also provide [documentation](https://humancompatible-detect.readthedocs.io/en/latest). For more details on installation, see [Installation details](#installation-details).
+
+---
+
+## Methods
+
+### Maximum Subgroup Discrepancy (MSD)
+
+MSD is the subgroup maximal difference in probability mass of a given subgroup, comparing the mass given by each distribution.
+
+<!-- ```math
+
+\text{MSD}(P,Q;\,𝒫)=
+\max_{S\;\text{sub-group on }𝒫}\;
+\bigl|\;P(S)-Q(S)\;\bigr|.
+
+``` -->
+
+- Naturally, two distributions are _fair_ iff all subgroups have similar mass.
+- The **arg max** immediately tells you _which_ group is most disadvantaged as an interpretable attribute-value combination.
+- MSD has linear sample complexity, a stark contrast to exponential complexity of other distributional distances (Wasserstein, TV...)
+
+### Subsampled ℓ∞ norm
+
+This method checks in a very efficient way whether the bias in any subgroup exceeds a given threshold. That is, it tells us to which extent, a particular subgroup obtains the positive outcome more or less frequently than the general trend in the dataset. Here, the fact that we can perform a subsampling with guaranties is key. It is the method of choice in cases in which one wants to be sure that a given dataset is compliant with a predefined acceptable bias level for all its subgroups.
+
+---
+
+## Installation details
+
+### Requirements
+
+All Python dependencies are declared in pyproject.toml (core + optional extras).
+
+- **Python ≥ 3.10**
+
+- **A MILP solver** (required for MSD).
+  > We use [Pyomo](https://pyomo.readthedocs.io/) for modelling. This allows for multiple solvers, see the lists of [solver interfaces](https://pyomo.readthedocs.io/en/stable/reference/topical/solvers/index.html) and [persistent solver interfaces](https://pyomo.readthedocs.io/en/stable/reference/topical/appsi/appsi.html).
+
+  - Default (recommended): HiGHS -- works out of the box because we install the HiGHS Python bindings (highspy) with the package.
+
+  - Optional commercial solvers (license required): Gurobi / CPLEX / Xpress
+  These require a valid installation + license from the vendor. (Some also have free community license, and pip-installable Python APIs.)
+
+  - Optional open-source fallback: GLPK requires the glpsol executable on your system PATH.
+
+- Other dependencies (installed automatically): numpy, pandas, scipy, pyomo, tqdm, etc.
+
+### (Optional) create a fresh environment
+
+```bash
+python -m venv .venv
+# Activate it
+source .venv/bin/activate     # Linux / macOS
+.venv\Scripts\activate.bat    # Windows -- cmd.exe
+.venv\Scripts\Activate.ps1    # Windows -- PowerShell
+```
+
+### Install the package
+
+```bash
+python -m pip install humancompatible-detect
+```
+
+### Optional extras
+
+To install with optional commercial solvers:
+
+```bash
+python -m pip install "humancompatible-detect[gurobi]"
+python -m pip install "humancompatible-detect[cplex]"
+python -m pip install "humancompatible-detect[xpress]"
+```
+
+Or if you want the notebooks + plotting dependencies:
+
+```bash
+python -m pip install "humancompatible-detect[examples]"
+```
+
+And if docs/dev dependencies are desired:
+
+```bash
+python -m pip install "humancompatible-detect[docs]"
+python -m pip install "humancompatible-detect[dev]"
+```
+
+### Verify it worked
+
+```bash
+python -c "from humancompatible.detect import detect_and_score; print('detect imported OK')"
+```
+
+If the import fails you'll see:
+
+```bash
+ModuleNotFoundError: No module named 'humancompatible'
+```
+
+---
+
+## References
+
+If you use the MSD in your work, please cite the following work:
+
+```bibtex
+@inproceedings{MSD,
+  author = {N\v{e}me\v{c}ek, Ji\v{r}\'{\i} and Kozdoba, Mark and Kryvoviaz, Illia and Pevn\'{y}, Tom\'{a}\v{s} and Mare\v{c}ek, Jakub},
+  title = {Bias Detection via Maximum Subgroup Discrepancy},
+  year = {2025},
+  isbn = {9798400714542},
+  publisher = {Association for Computing Machinery},
+  address = {New York, NY, USA},
+  url = {https://doi.org/10.1145/3711896.3736857},
+  doi = {10.1145/3711896.3736857},
+  booktitle = {Proceedings of the 31st ACM SIGKDD Conference on Knowledge Discovery and Data Mining V.2},
+  pages = {2174–2185},
+  numpages = {12},
+  location = {Toronto ON, Canada},
+  series = {KDD '25}
+}
+```
+
+If you used the ℓ∞ method, please cite:
+
+```bibtex
+@misc{matilla2025samplecomplexitybiasdetection,
+      title={Sample Complexity of Bias Detection with Subsampled Point-to-Subspace Distances},
+      author={M. Matilla, Germán and Mareček, Jakub},
+      year={2025},
+      eprint={2502.02623},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG},
+      url={https://arxiv.org/abs/2502.02623v1},
+}
+```

humancompatible_detect-0.1.4/humancompatible/detect/__init__.py

@@ -0,0 +1,13 @@
+from .detect_bias import most_biased_subgroup, most_biased_subgroup_csv, most_biased_subgroup_two_samples
+from .evaluate_bias import evaluate_biased_subgroup, evaluate_biased_subgroup_csv, evaluate_biased_subgroup_two_samples
+from .helpers.utils import detect_and_score
+
+__all__ = [
+    "detect_and_score",
+    "most_biased_subgroup",
+    "most_biased_subgroup_csv",
+    "most_biased_subgroup_two_samples",
+    "evaluate_biased_subgroup",
+    "evaluate_biased_subgroup_csv",
+    "evaluate_biased_subgroup_two_samples",
+]