rankaudit 0.1.0__tar.gz

rankaudit-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.env
+.venv
+venv/
+env/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.so
+.DS_Store

rankaudit-0.1.0/LICENSE

@@ -0,0 +1,163 @@
+                                 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 made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work.
+
+      "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 transformations
+      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, as submitted to the 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.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 any
+      Contribution incorporated within the Work constitutes patent 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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.
+
+   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.
+
+   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 reproducing 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 exemplary 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 all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or 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 offer such obligations 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 warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Mandar Narendra Parab
+
+   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.

rankaudit-0.1.0/PKG-INFO

@@ -0,0 +1,384 @@
+Metadata-Version: 2.4
+Name: rankaudit
+Version: 0.1.0
+Summary: Auditing and explainability library for ranking systems
+Project-URL: Homepage, https://github.com/m-np/rankaudit
+Project-URL: Repository, https://github.com/m-np/rankaudit
+Project-URL: Bug Tracker, https://github.com/m-np/rankaudit/issues
+License: Apache-2.0
+License-File: LICENSE
+Keywords: LLM,audit,counterfactuals,explainability,fairness,information-retrieval,ranking
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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 :: Software Development :: Libraries
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.23
+Provides-Extra: all
+Requires-Dist: anthropic>=0.25; extra == 'all'
+Requires-Dist: lime>=0.2; extra == 'all'
+Requires-Dist: pandas>=2.0; extra == 'all'
+Requires-Dist: shap>=0.44; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pandas>=2.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: lime
+Requires-Dist: lime>=0.2; extra == 'lime'
+Provides-Extra: llm
+Requires-Dist: anthropic>=0.25; extra == 'llm'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0; extra == 'pandas'
+Provides-Extra: shap
+Requires-Dist: shap>=0.44; extra == 'shap'
+Description-Content-Type: text/markdown
+
+# RankAudit
+
+**Auditing and explainability toolkit for ranking systems.**
+
+[![PyPI](https://img.shields.io/pypi/v/rankaudit)](https://pypi.org/project/rankaudit/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/m-np/rankaudit/blob/main/LICENSE)
+[![Tests](https://img.shields.io/badge/tests-19%20passed-brightgreen)](https://github.com/m-np/rankaudit/blob/main)
+[![Python](https://img.shields.io/pypi/pyversions/rankaudit)](https://pypi.org/project/rankaudit/)
+[![HuggingFace](https://img.shields.io/badge/🤗%20HuggingFace-ARB%20Benchmark-yellow)](https://huggingface.co/datasets/m-np/arb)
+
+> Ranking systems decide what people see and in what order — jobs, loans, news, products. RankAudit makes them inspectable.
+
+---
+
+## What is RankAudit?
+
+Most ranking systems — search engines, recommendation feeds, LLM re-rankers are black boxes. They produce an ordered list with no explanation of *why* document A ranked above B, whether the ranking is fair across demographic groups, or what a lower-ranked item would need to change to move up.
+
+RankAudit is a single Python library that closes this gap. It gives engineers and researchers four capabilities:
+
+| Capability | What it answers |
+|---|---|
+| **Measure** | How good is the ranking? (NDCG, MAP, MRR, Precision@k) |
+| **Explain** | Why did this document rank here? (ranking-aware SHAP/LIME) |
+| **Interrogate** | What would it take for this document to rank higher? (counterfactuals) |
+| **Detect** | Is the ranking fair across groups? (exposure, parity, position-relevance) |
+
+---
+
+## Why not existing tools?
+
+| Tool | Gap |
+|---|---|
+| SHAP / LIME | Explain a single score in isolation — ignore that ranking is comparative |
+| pytrec_eval / ranx | Compute quality metrics but give no insight into *why* or *where* unfairness lives |
+| Fairlearn / AI Fairness 360 | Designed for classifiers, not ranked lists |
+| **RankAudit** | Ranking-native attribution + counterfactuals + fairness, unified API |
+
+---
+
+## Installation
+
+```bash
+pip install rankaudit                  # core only (numpy)
+pip install "rankaudit[shap]"          # + SHAP attribution
+pip install "rankaudit[lime]"          # + LIME attribution
+pip install "rankaudit[llm]"           # + RankExplain (Anthropic / OpenAI)
+pip install "rankaudit[pandas]"        # + DataFrame loader
+pip install "rankaudit[all]"           # everything
+```
+
+---
+
+## Quick start
+
+```python
+import rankaudit as ra
+
+report = ra.audit(
+    ranker=my_ranker,
+    queries=["best laptop under $1000"],
+    docs=doc_corpus,
+    metrics=["ndcg", "fairness"],
+)
+
+print(report.summary())
+print(report.explain(doc_id="doc_42"))
+```
+
+---
+
+## Inputs
+
+RankAudit accepts four input formats. All normalise to the same internal `QueryDocPair` representation.
+
+### Option 1 — Raw queries + doc list (simplest)
+
+```python
+queries = ["best laptop under $1000", "noise cancelling headphones"]
+
+docs = [
+    {
+        "id": "doc_1",
+        "text": "The MacBook Air M3 offers excellent value...",
+        "relevance": 3,          # graded relevance label (0–3), optional
+        "group": "apple",        # group label for bias analysis, optional
+        "features": {            # numeric features your ranker uses
+            "bm25": 0.82,
+            "semantic_sim": 0.91,
+            "recency": 0.74,
+            "click_rate": 0.55,
+        },
+    },
+    ...
+]
+
+report = ra.audit(ranker=my_ranker, queries=queries, docs=docs)
+```
+
+### Option 2 — QueryDocPair objects (full control)
+
+```python
+from rankaudit import QueryDocPair
+
+pairs = [
+    QueryDocPair(
+        query_id="q1",
+        query_text="best laptop under $1000",
+        doc_id="doc_1",
+        doc_text="The MacBook Air M3 offers excellent value...",
+        features={"bm25": 0.82, "semantic_sim": 0.91, "recency": 0.74},
+        relevance=3.0,
+        metadata={"group": "apple"},
+    ),
+    ...
+]
+
+report = ra.audit(ranker=my_ranker, pairs=pairs)
+```
+
+### Option 3 — pandas DataFrame
+
+```python
+import pandas as pd
+import rankaudit as ra
+
+df = pd.DataFrame({
+    "query_id":          ["q1",    "q1",    "q1"],
+    "query_text":        ["best laptop"] * 3,
+    "doc_id":            ["doc_1", "doc_2", "doc_3"],
+    "doc_text":          ["MacBook Air...", "Dell XPS...", "Lenovo ThinkPad..."],
+    "relevance":         [3.0,     2.0,     1.0],
+    "feat_bm25":         [0.82,    0.61,    0.55],   # feat_ prefix → features dict
+    "feat_semantic_sim": [0.91,    0.78,    0.70],
+    "group":             ["apple", "dell",  "lenovo"],
+})
+
+pairs = ra.from_dataframe(df)
+report = ra.audit(ranker=my_ranker, pairs=pairs)
+```
+
+### Option 4 — TREC / LETOR benchmark files
+
+```python
+pairs = ra.load_trec(qrel_path="robust04.qrel", run_path="bm25.run")
+pairs = ra.load_letor(path="MQ2007/Fold1/train.txt")
+report = ra.audit(ranker=my_ranker, pairs=pairs)
+```
+
+### Implementing a ranker
+
+Any object with a `score` method works — scikit-learn estimators, PyTorch modules, ONNX sessions, and plain callables all qualify.
+
+```python
+class MyRanker:
+    def score(self, pairs: list[QueryDocPair]) -> list[tuple[str, float]]:
+        # Return (doc_id, score) for every pair — order doesn't matter
+        return [(p.doc_id, sum(p.features.values())) for p in pairs]
+```
+
+### What is required vs optional on each input
+
+| Field | Required? | Used by |
+|---|---|---|
+| `query_id`, `query_text` | Yes | All steps |
+| `doc_id`, `doc_text` | Yes | All steps |
+| `features` | No | Attribution (SHAP/LIME) and counterfactuals only |
+| `relevance` | No | IR metrics (NDCG, MAP, MRR, Precision@k) — all return 0 if omitted |
+| `metadata["group"]` | No | Bias detector — exposure and parity analysis only run when group labels are present |
+
+**What you get without optional fields:**
+
+```python
+# No features, no relevance, no group labels — still works
+pairs = [
+    QueryDocPair(query_id="q1", query_text="query", doc_id="d1", doc_text="doc text"),
+    ...
+]
+
+# Skip the steps that need features
+report = ra.audit(
+    ranker=my_ranker,
+    pairs=pairs,
+    attribution=None,       # requires features
+    counterfactuals=False,  # requires features
+)
+# → report.metrics will have NDCG/MAP of 0 (no relevance labels)
+# → report.bias will have position_bias only (no group labels)
+```
+
+**Full audit requires:**
+- `features` — for attribution and counterfactuals
+- `relevance` — for meaningful NDCG, MAP, MRR, Precision@k values
+- `metadata["group"]` — for exposure and demographic parity bias analysis
+
+---
+
+## Outputs
+
+`ra.audit(...)` returns an `AuditReport` object with four output surfaces.
+
+### report.summary()
+
+```
+=== RankAudit Report ===
+Queries audited : 2
+Documents ranked: 20
+Avg NDCG@10     : 0.7841
+Attributions    : 20 documents explained
+Counterfactuals : 4 flip examples
+Bias checks     : 2 queries analysed
+```
+
+### report.metrics — ranking quality
+
+All four metrics require `relevance` labels on your input pairs. They return 0 if no relevance labels are provided.
+
+| Metric | What it measures | `metrics=` value |
+|---|---|---|
+| **NDCG@k** | Quality of the top-k ranking, weighted by position | `"ndcg"` |
+| **Precision@k** | Fraction of relevant docs in the top-k | `"precision"` |
+| **MAP** | Average precision across all relevant docs | `"map"` |
+| **MRR** | How high the first relevant doc appears | `"mrr"` |
+| **Fairness / bias** | Exposure and parity across groups | `"fairness"` |
+
+Pass any combination to `ra.audit(metrics=[...])`. Default is `["ndcg", "fairness"]`.
+
+```python
+for m in report.metrics:
+    print(m.query_id, m.ndcg_at_k, m.map_score, m.mrr_score)
+
+# q1  {1: 1.0, 3: 0.92, 5: 0.87, 10: 0.78}  0.81  1.0
+# q2  {1: 0.5, 3: 0.71, 5: 0.74, 10: 0.69}  0.67  0.5
+```
+
+### report.explain() — feature attribution
+
+Ranking-aware attribution showing which features drove a document's position:
+
+```python
+print(report.explain(doc_id="doc_2"))
+```
+
+```
+Explanation for doc 'doc_2' (query 'q1') — method: shap
+  Base score   : 0.5312
+  Final score  : 0.7841
+  Top feature contributions:
+    semantic_sim    +0.1820
+    bm25            +0.0934
+    recency         -0.0381
+    click_rate      -0.0144
+```
+
+### report.counterfactuals — rank flip analysis
+
+Minimal feature change that would flip the order of two documents:
+
+```python
+for cf in report.counterfactuals:
+    print(f"Query {cf.query_id}: '{cf.doc_b_id}' (rank {cf.original_rank_b}) "
+          f"would overtake '{cf.doc_a_id}' (rank {cf.original_rank_a}) if:")
+    for feat, (current, needed) in cf.flipping_changes.items():
+        print(f"  {feat}: {current:.3f} → {needed:.3f}")
+
+# Query q1: 'doc_2' (rank 2) would overtake 'doc_1' (rank 1) if:
+#   recency: 0.450 → 0.720
+```
+
+### report.bias — fairness metrics
+
+Exposure and demographic parity across group labels:
+
+```python
+for b in report.bias:
+    print(b.query_id, b.exposure_bias, b.demographic_parity)
+    for note in b.notes:
+        print(" [!]", note)
+
+# q1  {'apple': 0.4821, 'dell': 0.2103, 'lenovo': 0.1874}  ...
+# [!] Exposure ratio between groups is 2.57x — significant disparity detected.
+# [!] Demographic parity gap is 0.50 — one group dominates top-k results.
+```
+
+### RankExplain — plain-English explanations via LLM
+
+```python
+from anthropic import Anthropic
+from rankaudit import RankExplain
+
+explainer = RankExplain(client=Anthropic(), model="claude-sonnet-4-6")
+
+print(explainer.explain_report(report))
+print(explainer.explain_doc(report, doc_id="doc_2"))
+print(explainer.explain_counterfactuals(report))
+print(explainer.explain_bias(report))
+```
+
+```
+The ranking system performs well overall (NDCG@10: 0.78) but shows a notable
+recency penalty — newer documents are discounted by ~30% relative to older ones
+with comparable semantic scores. The 'apple' group receives 2.5x more exposure
+than other groups, which may warrant investigation if group identity should not
+influence ranking position...
+```
+
+### Serialisation
+
+```python
+report.to_json()   # full report as a JSON string
+report.to_dict()   # plain Python dict
+```
+
+---
+
+## Citation
+
+If you use RankAudit in your research, please cite:
+
+```bibtex
+@software{parab2026rankaudit,
+  author  = {Parab, Mandar Narendra},
+  title   = {{RankAudit}: Auditing and Explainability for Ranking Systems},
+  year    = {2026},
+  url     = {https://github.com/m-np/rankaudit},
+  license = {Apache-2.0}
+}
+```
+
+---
+
+## Contributing
+
+Contributions are welcome. Please open an issue before submitting a large PR so we can align on direction. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+---
+
+## License
+
+Copyright 2026 Mandar Narendra Parab. Licensed under the [Apache License 2.0](https://github.com/m-np/rankaudit/blob/main/LICENSE).