Skip to content
v0.1.3latest release121 skills4 categories6 sub-categories247 tested scripts397 reference docsContact us

rank_eval.py

Helper script for learning-to-rank-model-builder · 171 lines

AI & Machine Learning / Classical Machine Learningv1.0.0Updated OCT 25 20263 references4 scripts
scripts/rank_eval.py
#!/usr/bin/env python3
"""Evaluate rankings per query: NDCG, MAP, MRR, ERR, precision@k, and whether model A really beats model B.

Input: CSV with query id, graded relevance label and one or more score columns (higher = ranked higher), e.g.
the predictions of several rankers on the same test documents: qid,label,bm25,lgbm_score,xgb_score.

Per score column (averaged over queries):
  NDCG@k   gain 2^label - 1 (--gain exp, the LightGBM/XGBoost/TREC default) or label (--gain linear, the
           scikit-learn ndcg_score convention), log2 discount
  MAP@k, MRR, P@k   binary relevance: label >= --rel-min
  ERR@k    expected reciprocal rank (cascade model; graded labels)
Queries without any relevant document have undefined NDCG: --empty skip (default, excluded and counted),
one (LightGBM's convention: counts as 1.0) or zero. Score ties are broken pessimistically by default (lower
label first, so a constant or coarse score cannot look good); --ties input keeps file order within ties, which
reproduces LightGBM's own NDCG@k evaluation (rows in group order), --ties optimistic the upper bound.
Comparison (--baseline COLUMN): for every other column, the mean per-query NDCG@k difference with a
95% bootstrap CI over queries and a paired randomisation (sign-flip) test p-value (10,000 permutations,
seeded) - queries are the unit of analysis, not documents.

Usage:
    python rank_eval.py ltr.csv --qid-col qid --label-col label --scores bm25 clicks score --k 5 10
    python rank_eval.py preds.csv --scores lgbm xgb --baseline bm25 --k 10 --gain linear
    python rank_eval.py preds.csv --scores model --k 10 --per-query worst.csv --json

Exit codes: 0 evaluated, 1 with --baseline when no model is significantly better (p < 0.05), 2 usage error.
"""

import argparse
import csv
import json
import math
import os
import random
import sys
from collections import defaultdict

sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
from _rank_metrics import average_precision, err, ndcg, precision, rank_by, reciprocal_rank  # noqa: E402


def num(v):
    try:
        x = float(v)
        return x if math.isfinite(x) else None
    except (TypeError, ValueError):
        return None


def per_query(groups, col, k, a, max_label):
    out = {}
    for q, docs in groups.items():
        d = [(lab, s[col]) for lab, s in docs]
        ranked = rank_by(d, a.ties)
        nd = ndcg(ranked, k, a.gain)
        if nd is None:
            nd = {"skip": None, "one": 1.0, "zero": 0.0}[a.empty]
        out[q] = {"ndcg": nd, "map": average_precision(ranked, k, a.rel_min), "mrr": reciprocal_rank(ranked, a.rel_min),
                  "p": precision(ranked, k, a.rel_min), "err": err(ranked, k, max_label)}
    return out


def mean(xs):
    xs = [x for x in xs if x is not None]
    return sum(xs) / len(xs) if xs else None


def compare(base, other, seed=0, boots=2000, perms=10000):
    qs = [q for q in base if base[q]["ndcg"] is not None and other[q]["ndcg"] is not None]
    diffs = [other[q]["ndcg"] - base[q]["ndcg"] for q in qs]
    n = len(diffs)
    md = sum(diffs) / n
    rng = random.Random(seed)
    bs = sorted(sum(diffs[rng.randrange(n)] for _ in range(n)) / n for _ in range(boots))
    ci = (bs[int(0.025 * boots)], bs[int(0.975 * boots) - 1])
    obs = abs(md)
    extreme = 0
    for _ in range(perms):
        s = sum(d if rng.random() < 0.5 else -d for d in diffs) / n
        if abs(s) >= obs - 1e-15:
            extreme += 1
    return {"queries": n, "mean_diff": md, "ci": ci, "p": (extreme + 1) / (perms + 1),
            "wins": sum(1 for d in diffs if d > 1e-12), "losses": sum(1 for d in diffs if d < -1e-12)}


def main():
    ap = argparse.ArgumentParser(description="Evaluate rankings per query.", epilog=__doc__,
                                 formatter_class=argparse.RawDescriptionHelpFormatter)
    ap.add_argument("csv")
    ap.add_argument("--qid-col", default="qid")
    ap.add_argument("--label-col", default="label")
    ap.add_argument("--scores", nargs="+", required=True)
    ap.add_argument("--k", type=int, nargs="+", default=[10])
    ap.add_argument("--gain", choices=["exp", "linear"], default="exp")
    ap.add_argument("--rel-min", type=float, default=1)
    ap.add_argument("--empty", choices=["skip", "one", "zero"], default="skip")
    ap.add_argument("--ties", choices=["pessimistic", "input", "optimistic"], default="pessimistic",
                    help="order of documents with equal scores (input = file order, as LightGBM does)")
    ap.add_argument("--baseline", help="score column to compare every other column against")
    ap.add_argument("--per-query", help="write per-query NDCG@k (first k) for each column to this CSV")
    ap.add_argument("--json", action="store_true")
    a = ap.parse_args()
    try:
        with open(a.csv, newline="", encoding="utf-8") as f:
            rows = list(csv.DictReader(f))
        if not rows:
            raise ValueError("no rows")
        cols = [a.qid_col, a.label_col] + a.scores + ([a.baseline] if a.baseline else [])
        miss = [c for c in cols if c not in rows[0]]
        if miss:
            raise ValueError(f"columns not found: {', '.join(miss)}")
        groups = defaultdict(list)
        for r in rows:
            lab = num(r[a.label_col])
            if lab is None:
                raise ValueError("labels must be numeric")
            groups[r[a.qid_col]].append((lab, {c: num(r[c]) if num(r[c]) is not None else -math.inf
                                               for c in set(a.scores) | ({a.baseline} if a.baseline else set())}))
    except (OSError, ValueError) as e:
        print(f"error: {e}", file=sys.stderr)
        return 2
    max_label = max(lab for g in groups.values() for lab, _ in g)
    columns = list(dict.fromkeys(([a.baseline] if a.baseline else []) + a.scores))
    res = {"queries": len(groups), "gain": a.gain, "results": {}, "comparisons": {}}
    pq_first = {}
    for k in a.k:
        res["results"][k] = {}
        for c in columns:
            pq = per_query(groups, c, k, a, max_label)
            if k == a.k[0]:
                pq_first[c] = pq
            vals = list(pq.values())
            res["results"][k][c] = {m: mean(v[m] for v in vals) for m in ("ndcg", "map", "mrr", "p", "err")}
            res["results"][k][c]["evaluated"] = sum(1 for v in vals if v["ndcg"] is not None)
    empty = sum(1 for g in groups.values() if not any(lab >= a.rel_min for lab, _ in g))
    if a.baseline:
        for c in a.scores:
            if c != a.baseline:
                res["comparisons"][c] = compare(pq_first[a.baseline], pq_first[c])
    if a.per_query:
        with open(a.per_query, "w", newline="", encoding="utf-8") as f:
            w = csv.writer(f)
            w.writerow(["qid"] + [f"{c}_ndcg@{a.k[0]}" for c in columns])
            for q in groups:
                w.writerow([q] + [pq_first[c][q]["ndcg"] for c in columns])
    if a.json:
        print(json.dumps(res, indent=2, default=str))
    else:
        print(f"queries: {len(groups)}   gain: {a.gain}   relevant: label >= {a.rel_min:g}   "
              f"queries without relevant documents: {empty} ({'excluded' if a.empty == 'skip' else 'NDCG=' + a.empty})")
        for k in a.k:
            print(f"\n@{k}")
            print(f"{'model':<20} {'NDCG':>8} {'MAP':>8} {'MRR':>8} {'P':>8} {'ERR':>8}")
            for c, v in sorted(res["results"][k].items(), key=lambda kv: -(kv[1]["ndcg"] or 0)):
                print(f"{c:<20} " + " ".join(f"{(v[m] if v[m] is not None else float('nan')):>8.4f}"
                                             for m in ("ndcg", "map", "mrr", "p", "err")))
        if res["comparisons"]:
            print(f"\npaired comparison vs {a.baseline} (NDCG@{a.k[0]}, per query):")
            for c, d in res["comparisons"].items():
                verdict = "better" if d["p"] < 0.05 and d["mean_diff"] > 0 else (
                    "worse" if d["p"] < 0.05 else "no significant difference")
                print(f"  {c:<18} diff {d['mean_diff']:+.4f} [95% CI {d['ci'][0]:+.4f}, {d['ci'][1]:+.4f}]  "
                      f"p = {d['p']:.4f}  wins/losses {d['wins']}/{d['losses']}  -> {verdict}")
    if a.baseline and res["comparisons"]:
        if not any(d["p"] < 0.05 and d["mean_diff"] > 0 for d in res["comparisons"].values()):
            return 1
    return 0


if __name__ == "__main__":
    sys.exit(main())
More in Classical Machine Learning

anomaly-detection-model-builder

Build and evaluate anomaly detection for tabular, sensor and transaction data with few or no labels: define the anomaly type (point, contextual, collective), choose detectors (robust z-score/MAD and IQR rules, Mahalanobis with robust covariance, k-NN distance, LOF, Isolation Forest, one-class SVM, PCA reconstruction / autoencoders, forecasting residuals for time series), combine them by rank, explain each alert by its deviating features, set thresholds from an alert budget or the score distribution, and evaluate with precision@k, PR-AUC and recall on known incidents, or detector agreement when no labels exist. Includes pure-Python detectors (robust z, Mahalanobis, kNN, Isolation Forest, ensemble) and an evaluation script.

catboost-model-builder

Build CatBoost models that use its strengths correctly: raw categorical columns as cat_features (ordered target statistics, no manual encoding), text_features, Pool construction with NaN-safe categories, ordered boosting and has_time for temporal data, symmetric (oblivious) trees, overfitting detector with eval_set and use_best_model, losses for classification, regression (Quantile, Poisson, Tweedie) and ranking (YetiRank), class weights, monotone constraints, feature importance (PredictionValuesChange, LossFunctionChange) and SHAP values, GPU training and model export. Plans cat/text/numeric columns from a CSV and generates a runnable training script, and checks parameter sets for the conflicts CatBoost rejects (iterations vs n_estimators, Bayesian bootstrap with subsample, multiple class-weight options, depth > 16, use_best_model without eval_set).

categorical-encoding-selector

Choose and implement the right encoding for every categorical column given the model family and the data: one-hot (with infrequent-level grouping and handle_unknown), ordinal with an explicit order, cross-fitted target encoding (scikit-learn TargetEncoder, CatBoost ordered statistics, category_encoders inside CV), frequency/count encoding, feature hashing, native categorical support in LightGBM, HistGradientBoosting, XGBoost and CatBoost, prefix levels for codes (zip3, NAICS-2), and embeddings. Measures cardinality, rare-level share, unseen-level rate on a time-ordered holdout and target signal per column, emits the ColumnTransformer, and quantifies target-encoding leakage (in-sample vs out-of-fold vs holdout AUC).

classification-model-selector

Choose the right classification algorithm for tabular, text or mixed data and prove the choice with a fair bake-off: logistic regression (L2, L1, elastic net), linear SVM, naive Bayes, k-NN, RBF SVM, decision trees, random forest, extra trees, HistGradientBoosting, LightGBM, XGBoost, CatBoost, explainable boosting machines (EBM/GAM), points scorecards and MLPs, matched to data size, width, categorical and high-cardinality share, missingness, class imbalance, text, and constraints such as interpretability, monotonic constraints, calibrated probabilities, latency budgets and tiny deployable models. Ranks candidates with starting hyperparameters and cautions, then generates a bake-off script running every candidate on identical CV folds with per-fold metrics, fit time and prediction latency.

clustering-algorithm-selector

Choose the right clustering algorithm and check that clustering makes sense at all: cluster tendency (Hopkins statistic with a correlated-features caveat, nearest-neighbour isolation), then k-means / MiniBatchKMeans, Gaussian mixtures with BIC, agglomerative (Ward, average, complete, single) with dendrograms, DBSCAN, HDBSCAN, OPTICS, spectral clustering, BIRCH, mean shift, k-prototypes and k-modes for mixed or categorical data, and Gower distance, matched to data size, expected shapes, noise, varying density, known k, soft memberships, hierarchy and streaming. Covers preprocessing (scaling, encoding, dimensionality, distance metrics), validation (internal indices, bootstrap stability, external labels, business profiling) and assigning new points.

collaborative-filtering-implementer

Implement collaborative filtering recommenders that beat popularity: item-based kNN with cosine, Jaccard or asymmetric similarity, shrinkage, neighbourhood size, positive-only or mean-centred rating signals and 'because you liked X' explanations; implicit ALS with confidence weighting, BPR pairwise ranking and the closed-form EASE model in plain NumPy, tuned on a temporal validation split by recall@k and NDCG@k and refit on all data; plus user-kNN, explicit matrix factorisation, the implicit/LightFM libraries, hyperparameter ranges, cold-start fallbacks, scaling with sparse matrices and approximate nearest neighbours. Produces top-k lists in the format of the recommendation evaluator.