Skip to content

Repository files navigation

ActEval

PyPI version Python versions CI Documentation License

Model-agnostic evaluation for actuarial predictive models.

ActEval evaluates prediction arrays—not fitted model objects—across accuracy, calibration, discrimination, probabilistic quality, uncertainty, observed-tail risk, and financial decisions. It works with outputs from GLMs, scikit-learn, XGBoost, CatBoost, neural networks, or any other modelling stack.

The project is designed for non-life insurance pricing workflows. It keeps actuarial objectives separate and never creates an arbitrary universal model score.

Why ActEval?

A model with lower RMSE can still have worse aggregate calibration, weaker large-loss behavior, or a less favorable pricing consequence. ActEval makes those trade-offs visible through explicit metrics and versioned evaluation metadata.

Capability Included diagnostics
Point predictions MAE, RMSE, Poisson/Gamma/Tweedie deviance
Calibration A/E, calibration by risk quantile, weighted calibration error
Discrimination Gini, normalized Gini, lift
Tail risk Observed-tail MAE, RMSE, A/E, large-loss bias
Predictive distributions CRPS, log, Brier, quantile, and interval scores
Uncertainty Coverage, width, variance, entropy, bootstrap intervals
Model comparison Metric-specific ranking and paired bootstrap differences
Monitoring Segment reports, temporal validation, prediction drift/PSI
Realized consequences Explicit pricing loss, shortfall, and quoted reinsurance arithmetic
Reporting DataFrame, dictionary, CSV, JSON, HTML, and plot export

Installation

ActEval requires Python 3.11 or newer.

python -m pip install acteval-insurance

Install the optional plotting support with:

python -m pip install "acteval-insurance[plot]"

Numerical CDF, density, and entropy methods on TweedieDistribution use an optional dependency:

python -m pip install "acteval-insurance[tweedie]"

Tweedie deviance itself comes from scikit-learn and does not require this extra.

The distribution name is acteval-insurance because acteval was already occupied on PyPI. The import remains concise:

import acteval as ae

The package also installs a command-line interface for CSV prediction files:

acteval evaluate predictions.csv --task claim_frequency

Use acteval evaluate --help for column, metric, weighting, and report-export options.

Run the same CLI from the public multi-platform container without installing Python locally:

docker run --rm ghcr.io/aminemanai2003/acteval:latest --version

See the container guide for CSV mounts, report output, image tags, and provenance verification.

The repository also includes a deployable Gradio workbench for evaluating a prediction CSV in the browser. It provides task-aware column mapping, metric tables, weighted calibration bands, and downloadable standalone reports:

python -m pip install "gradio==6.25.0"
cd space
python app.py

See the interactive demo guide for its data limits, privacy boundary, and Hugging Face deployment workflow.

Quick start

ActEval accepts ordinary NumPy-compatible arrays and returns structured result objects.

import acteval as ae

y_true = [0.0, 0.4, 1.0, 2.0, 4.0, 7.0]
y_pred = [0.1, 0.5, 0.9, 1.8, 3.6, 6.4]
exposure = [1.0, 0.5, 1.2, 0.8, 1.5, 2.0]

result = ae.evaluate(
    y_true,
    y_pred,
    exposure=exposure,
    input_scale="rate",
    task="claim_frequency",
    context={"model_id": "frequency-glm-v4", "split": "holdout", "split_seed": 42},
)

print(result.to_dataframe())

Task defaults avoid making portfolio-specific tail thresholds or Tweedie-power assumptions. Select those metrics explicitly and record their parameters:

result = ae.evaluate(
    y_true,
    y_pred,
    task="claim_frequency",
    metrics=[
        "rmse",
        "poisson_deviance",
        "ae_ratio",
        "normalized_gini",
        "tail_ae_95",
    ],
)

Parameterized metrics use MetricSpec, keeping every assumption in result metadata:

result = ae.evaluate(
    y_true,
    y_pred,
    task="pure_premium",
    metrics=[
        ae.MetricSpec("tweedie_deviance", {"power": 1.7}),
        ae.MetricSpec("tail_mae", {"quantile": 0.99}, label="tail_mae_99"),
    ],
)

Compare models

comparison = ae.compare(
    y_true,
    {
        "GLM": glm_predictions,
        "Gradient boosting": boosting_predictions,
    },
    exposure=exposure,
    input_scale="rate",
    task="claim_frequency",
)

print(comparison.to_dataframe())
print(comparison.rank("poisson_deviance"))

Rankings are metric-specific. Target metrics such as A/E are ranked by distance from their target; ActEval does not declare one model universally best.

Quantify sampling uncertainty

Rows, predictions, exposures, and weights are resampled jointly.

intervals = ae.bootstrap_evaluate(
    y_true,
    y_pred,
    exposure=exposure,
    input_scale="rate",
    task="claim_frequency",
    metrics=["rmse", "ae_ratio", "normalized_gini", "tail_ae_95"],
    n_resamples=2_000,
    confidence_level=0.95,
    random_state=42,
)

print(intervals.to_dataframe())

For model comparisons, paired resampling evaluates every model on the same bootstrap rows. Negative objective_delta favors the candidate model after accounting for whether a metric is minimized, maximized, or has a target.

paired = ae.paired_bootstrap_compare(
    y_true,
    {"Current GLM": glm_predictions, "Candidate": boosting_predictions},
    reference="Current GLM",
    task="claim_frequency",
    metrics=["poisson_deviance", "ae_ratio", "normalized_gini"],
    n_resamples=2_000,
    random_state=42,
)

Confidence intervals are descriptive sampling-uncertainty estimates. Paired comparisons are not automatically adjusted for multiple testing.

Segment and temporal monitoring

The v0.5 monitoring layer evaluates portfolio slices without changing the meaning of the underlying metrics.

segments = ae.evaluate_by_segment(
    y_true,
    y_pred,
    segment_labels,
    task="claim_frequency",
    exposure=exposure,
    input_scale="rate",
    metrics=["ae_ratio", "normalized_gini", "tail_ae_95"],
)

timeline = ae.evaluate_over_time(
    y_true,
    y_pred,
    accounting_period,
    task="claim_frequency",
    exposure=exposure,
    input_scale="rate",
    metrics=["poisson_deviance", "ae_ratio"],
)

drift = ae.prediction_drift(
    reference_predictions,
    current_predictions,
    n_bins=10,
)

Prediction drift uses fixed, weighted reference-quantile bins and reports PSI contributions. ActEval intentionally applies no universal PSI alert threshold.

Predictive distributions

Built-in vectorized adapters represent one predictive distribution per observation:

  • PoissonDistribution(mu)
  • NegativeBinomialDistribution(mean, dispersion)
  • GammaDistribution(mean, shape)
  • LognormalDistribution(meanlog, sdlog)
  • TweedieDistribution(mean, power, dispersion) for 1 < power < 2
  • EmpiricalDistribution(samples) for joint or independent scenario draws
poisson = ae.PoissonDistribution(mu=frequency_predictions)

distribution_result = ae.evaluate_distribution(
    claim_counts,
    poisson,
    task="claim_frequency",
    exposure=exposure,
    input_scale="rate",
    metrics=[
        ae.MetricSpec("crps", {"n_samples": 5_000, "random_state": 42}),
        "log_score",
        ae.MetricSpec("interval_score", {"coverage": 0.90}),
    ],
)

Samples have shape (n_samples, n_observations). Scalar quantiles have shape (n_observations,); vector quantiles have shape (n_quantiles, n_observations).

Illustrative realized-consequence helpers

These small helpers expose their loss function and named benchmark. Regret is reported in that loss function's unit.

premiums = ae.premium_from_distribution(
    severity_distribution,
    profit_loading=0.08,
    expense_ratio=0.20,
)

pricing = ae.pricing_regret(
    y_true=realized_loss,
    premium=premiums,
    benchmark_premium=current_tariff,
    underpricing_cost=2.0,
    overpricing_cost=1.0,
    benchmark_name="current tariff",
)

ActEval also provides loss-ratio impact, shortfall arithmetic, and quoted stop-loss option selection. These are illustrative realized-consequence calculations, not pricing, reserving, treaty, or regulatory-capital models.

Reports and exports

Result objects support DataFrames, dictionaries, printable summaries, and standalone HTML reports:

result.save_html("reports/frequency-evaluation.html")
comparison.save_html("reports/model-comparison.html")

ae.export_table(comparison, "reports/model-comparison.csv")
ae.export_table(comparison, "reports/model-comparison.json")

axis = ae.plot_calibration(y_true, y_pred, exposure=exposure)
ae.save_plot(axis, "reports/calibration.png", dpi=180)

HTML reports contain no JavaScript or remote assets and can be archived for offline review.

Input contract

  • y_true and y_pred are finite, one-dimensional, nonnegative arrays on the same scale.
  • Frequency and pure-premium rates supplied with policy exposure must set input_scale="rate"; aggregate counts or losses must omit exposure.
  • Severity observations are normally claim-level; sample_weight is often more meaningful than exposure.
  • When both are present, effective weight is sample_weight * exposure.
  • ActEval does not silently convert claim counts to rates.
  • Observed-tail diagnostics select rows using realized outcomes and are retrospective—not predictive tail probabilities.

Scope and limitations

ActEval is an insurance-oriented metric and reporting toolkit. It is not a complete model-validation or governance system. In particular:

  • it evaluates caller-supplied holdout predictions and cannot detect leakage, an invalid train/test split, or unrepresentative data;
  • risk-quantile and caller-defined segment reports do not replace feature-aware conditional calibration diagnostics;
  • the IID bootstrap does not refit models and does not handle clusters, time dependence, or multiplicity automatically;
  • no claim of production readiness or empirical superiority is made from the synthetic examples and unit tests in this repository;
  • thresholds, Tweedie powers, tail levels, financial loss functions, and deployment decisions remain portfolio- and governance-specific.

Use the context argument to record model and split identifiers, but treat the result as one evidence artifact rather than a governance decision.

Documentation

Development

git clone https://github.com/aminemanai2003/acteval.git
cd acteval
python -m venv .venv
python -m pip install -e ".[dev]"
ruff check .
ruff format --check .
mypy src/acteval
pytest
mkdocs build --strict
python -m build

Contributions are welcome. Read CONTRIBUTING.md and the security policy before opening a pull request or reporting a vulnerability.

Versioning and license

ActEval uses Semantic Versioning for its public API. Package maturity remains beta; compatibility rules do not imply actuarial validation or production readiness.

Licensed under the Apache License 2.0.

About

Model-agnostic evaluation, uncertainty and reporting for actuarial predictive models.

Topics

Resources

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages