Skip to main content

Wrong-Way Risk (WWR) estimation for counterparty credit risk.

Project description

wayfault

Wrong-Way Risk (WWR) estimation for counterparty credit risk.

wayfault quantifies the adverse dependence between exposure and counterparty credit quality — the risk that exposure rises precisely when the counterparty deteriorates (WWR), and its favourable mirror, Right-Way Risk (RWR). It takes a Monte-Carlo exposure cube and a credit curve as inputs and produces:

  • baseline (independence-assumption) exposure metrics and CVA,
  • a conditional expected exposure given default under a pluggable dependence model,
  • a WWR-adjusted CVA and the empirical alpha multiplier α = WWR-CVA / independent-CVA,
  • ML-based calibration of the dependence parameter,
  • WWR/RWR classification and diagnostics.

The library does not generate exposures or bootstrap curves — those are inputs.

🎮 Live playground

An interactive browser playground runs the real wayfault wheel via WebAssembly (Pyodide) — no install, no server. Adjust the dependence model and parameters and watch the CVA, alpha multiplier, and exposure charts recompute live.

Architecture

wayfault follows a strict hexagonal (ports & adapters) design. The dependency rule points inward: adapters → application → ports → domain. The domain, application, and ports layers import only the standard library and numpy. Optional adapters import their heavy dependencies lazily and raise a clear MissingDependencyError if the extra is not installed.

Install

pip install -e .                       # core (numpy only)
pip install -e '.[io,ml,viz,dev]'      # with all optional extras + tooling

Optional extras:

Extra Enables Pulls in
[io] CSV/Parquet source adapters pandas, pyarrow
[ml] scikit-learn survival calibrator scikit-learn
[viz] diagnostic plots matplotlib
[dev] tests, type-checking, linting pytest, mypy, …

Quickstart

import numpy as np
from wayfault import estimate_wwr
from wayfault.adapters.outbound.exposure_inmemory import InMemoryExposureSource
from wayfault.adapters.outbound.credit_flat import FlatHazardCreditCurveSource
from wayfault.adapters.outbound.dependence_hullwhite import HullWhiteHazardModel

cube = np.random.default_rng(0).normal(size=(10_000, 12)) + 1.0  # scenarios x tenors
tenors = [i / 4 for i in range(1, 13)]                           # quarterly to 3y

result = estimate_wwr(
    exposure=InMemoryExposureSource(cube, tenors),
    credit=FlatHazardCreditCurveSource(hazard=0.02, recovery=0.4),
    model=HullWhiteHazardModel(b=0.5),   # b > 0  ->  wrong-way
)

print(result.baseline_cva, result.wwr_cva, result.alpha, result.classification)

A full runnable example lives in examples/quickstart.py and uses only the in-memory adapters (zero extras).

CLI

python -m wayfault estimate \
    --exposure cube.csv --credit curve.csv \
    --model hullwhite --b 0.5 --out result.json

(--exposure/--credit CSV ingestion requires the [io] extra.)

Dependence models

Model Knob WWR when Notes
IndependentModel conditional EE ≡ unconditional EE
HullWhiteHazardModel b b > 0 λ(t) = exp(a(t) + b·V(t)) (Hull–White)
GaussianCopulaModel ρ ρ > 0 one-factor Gaussian copula
ClaytonCopulaModel θ θ > 0 Archimedean, lower-tail dependence
FrankCopulaModel θ θ > 0 Archimedean, symmetric (sign sets direction)

All models are numpy-only and fully vectorised across tenors.

Calibration

  • RegressionCalibrator — numpy-only OLS estimate of the Hull–White b.
  • SklearnSurvivalCalibrator[ml] covariate-hazard surrogate.

Visualization

The [viz] extra adds a beautiful matplotlib plotting module (wayfault.adapters.outbound.viz) — lazily imported, so the core stays numpy-only. Regenerate the gallery with pip install 'wayfault[viz]' then python examples/gallery.py.

Exposure profiles — EPE vs conditional EE, shaded WWR adjustment EE ratio — per-tenor conditional/unconditional
Exposure profiles EE ratio
Alpha sweep — alpha & CVA vs the dependence knob Dashboard — everything at a glance
Alpha sweep Dashboard
from wayfault.adapters.outbound import viz
fig = viz.plot_dashboard(result, bs=bs, alphas=alphas, wwr_cvas=wwr_cvas)
viz.save(fig, "dashboard.png")

Performance

Two acceleration techniques, both numpy-only:

  • Vectorised re-weighting — every model re-weights the whole exposure cube in a single numpy expression (no per-tenor Python loop).
  • Parallel batch & sweepwayfault.application.parallel fans independent estimates across workers with deterministic, input-order results:
from wayfault.application.parallel import sweep_models
from wayfault.adapters.outbound.dependence_hullwhite import HullWhiteHazardModel

results = sweep_models(
    exposure, credit,
    [HullWhiteHazardModel(b=b) for b in np.linspace(-1.2, 1.2, 25)],
    max_workers=8,            # threads (numpy releases the GIL); or pass a ProcessPoolExecutor
)
alphas = [r.alpha for r in results]

See the Performance docs.

Development

pytest                 # tests
mypy --strict src      # type checks
ruff check             # lint

Reference: Hull & White, CVA and Wrong-Way Risk (2012).

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wayfault-0.2.1.tar.gz (372.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wayfault-0.2.1-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file wayfault-0.2.1.tar.gz.

File metadata

  • Download URL: wayfault-0.2.1.tar.gz
  • Upload date:
  • Size: 372.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for wayfault-0.2.1.tar.gz
Algorithm Hash digest
SHA256 675726c211a7e88f006d135d700f74956640afa204d65d6dc6bcf45c1b2cd382
MD5 554636c75e7f0dea21e751599130a2e4
BLAKE2b-256 5245e176cb0795a5b20f668ec910d87a76426b3e0943d5889dc54849aef22784

See more details on using hashes here.

File details

Details for the file wayfault-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: wayfault-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for wayfault-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0333051d0763e5ec5a43683e77f76c06676afe323539dadaf8f0fecc8bbc031b
MD5 d76fadde254ef8eae427501ed86dcbe5
BLAKE2b-256 9b1a51ad95b75d857c762db9ab2d2ad99500ef2beee366bd5e99db4e033416ed

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page