Skip to main content

creforge

CI PyPI Python License

PII-safe synthetic credit bureau data, generated from explicit behavioural rules.

creforge generates realistic, linked credit-bureau-shaped datasets: borrowers, credit inquiries, accounts, the joint borrowers and guarantors on them, and monthly payment histories. The data has real delinquency dynamics, vintage curves and stress scenarios, and no real data ever goes in. There is no model fitted to real records, so there is nothing to memorise or leak.

Use it to test credit data pipelines, demo dashboards, teach credit-risk analytics, benchmark warehouses, or give contractors and vendors a realistic dataset without a data-sharing agreement.

$ pip install creforge
$ creforge generate --subjects 1000000 --months 36 --seed 42 --out ./bureau --workers 4
$ creforge validate ./bureau --strict

Why not SDV / Faker?

Faker-style Fit-to-real (SDV, GAN, ...) creforge
Needs real data No Yes: privacy review, leakage risk No
Delinquency dynamics None Learned; can break the rules Explicit Markov model
Can a loan jump from current to 90+? n/a Yes Never (tested invariant)
Referential integrity across tables Manual Often approximate Guaranteed and validated
Reproducible Mostly Rarely byte-identical Byte-identical per seed, any worker count
Explainable parameters n/a No Every probability is in a commented YAML file

The data

Table One row per Highlights
subject borrower Latent risk_grade A–E is exported, so it doubles as ground truth for testing scorecards. No names, IDs or addresses.
inquiry credit application Approval odds fall as a borrower makes more applications ("credit hungry" behaviour).
account credit facility credit_card, personal_loan, mortgage, auto_loan, overdraft, bnpl. New accounts link to their approved inquiry. Older accounts start part-way through their life.
account_month account × month Balance, amount due, amount paid, DPD bucket (0 … 120+), months in arrears, status.
account_party person on an account Role primary, joint or guarantor. About 40% of mortgages are joint; personal and auto loans to risky or young borrowers often have a guarantor (typically an older relative with a better grade).

Output is one Parquet or CSV part file per chunk per table, plus a manifest.json recording the version, seed, full resolved config and its SHA-256.

How it works

Every month, each open account draws one event: roll (miss a payment, move one bucket worse), cure (pay all arrears), back (pay one installment of arrears), restructure, close, or stay. The probabilities are

base[product, state] × grade multiplier × seasoning(months on book) × macro(month)

The DPD bucket is derived from months in arrears. Balances and payments are derived from the event. So an account can never skip a bucket, pay while rolling forward, or show a DPD that disagrees with its arrears. Accounts that already exist when the window opens start in a state drawn from the model's own age-conditional distribution, so the first month shows no warm-up artefact.

Joint accounts blend both borrowers' risk. Guaranteed loans that reach 90+ DPD can be rescued when the guarantor is called and pays off the arrears, so fewer of them are written off.

Validation

creforge validate reports:

  • Integrity (hard guarantees; any failure is a bug): unique ids, every foreign key resolves, the account opens on or after its approved inquiry, month histories are contiguous and end at closure, no rows after write-off, no skipped buckets, no payment on a roll-forward, no negative amounts, exactly one primary borrower per account, and no person listed twice on the same account.
  • Calibration (against the profile's targets): 30+ DPD share and annual write-off rate per product; 12-month bad rate increasing across grades; the seasoning peak falls at 6–35 months on book; no artefact at the start of the window; joint accounts go bad less often and guaranteed loans are written off less often than comparable single-borrower accounts; guarantors have better grades than the borrowers they back.
  • Privacy statement, with the config hash, to attach to data-handling approvals.

Baseline, 50k subjects × 36 months, seed 11 (creforge 0.2):

Product 30+ DPD share Annual write-off rate
credit_card 3.9% 3.7%
personal_loan 4.4% 3.4%
mortgage 1.0% 0.4%
auto_loan 3.0% 2.1%
overdraft 2.8% 2.5%
bnpl 6.5% 0.8%

12-month bad rate by grade: A 0.05% · B 0.4% · C 1.4% · D 6.5% · E 17%.

Quickstart notebook

examples/quickstart.ipynb walks through generating a portfolio and building vintage curves, a roll-rate matrix, a simple scorecard check against the known risk grade, and a baseline-vs-stressed comparison.

Python API

import creforge as cf

cfg = cf.Config.from_profile("stressed", subjects=100_000, months=48, seed=7)
ds = cf.generate(cfg)                  # in memory; ds.account_month is a polars DataFrame
report = cf.validate(ds)
print(report.to_markdown())

cf.write_dataset(cfg, "out/", workers=4)   # streaming, bounded memory, for big runs

Profiles

baseline (flat economy) and stressed (roll rates ramp to 1.8× around month 15, then recover) are built in. creforge profiles show baseline prints every parameter. To make your own, write a YAML file that starts with extends: baseline and override only what you need:

extends: baseline
name: subprime_cards
grades:
  E: {share: 0.20}     # fields merge; this assumes you rebalance the other shares

All built-in parameters are illustrative. They are hand-set to land in the right order of magnitude compared with publicly published aggregate statistics (sources are cited in the YAML). They do not describe any real lender's or bureau's portfolio.

Performance

Run Time Peak memory per worker Parquet size
200k subjects × 36 months, 1 worker 15 s < 1 GB 0.16 GB
1M subjects × 36 months, 4 workers 24 s 0.9 GB 0.78 GB

Measured on a 4-vCPU Linux container. Run python benchmarks/bench_generate.py to measure your own machine.

Roadmap

  1. Guarantor and joint-account links: done in 0.2.
  2. Contagion: a called guarantee raising the guarantor's own risk; supplementary cards.
  3. Business subjects, directors and shareholding graphs.
  4. Collateral and legal/litigation records.
  5. Clearly marked synthetic PII for UI testing.
  6. Calibration to published aggregate statistics.
  7. Scripted scenarios (moratoria, rate shocks).
  8. DuckDB/Postgres/Iceberg loaders; dbt and Glue catalog integration.
  9. Country flavour packs built only from public specifications.

Contributing

See CONTRIBUTING.md, including the clean-room rule. Changes are listed in CHANGELOG.md; report vulnerabilities privately as described in SECURITY.md.

$ pip install -e ".[dev]"
$ ruff check . && pytest -m "not slow"   # fast suite
$ pytest -m slow                         # calibration suite

CI runs on Linux, macOS and Windows with Python 3.10–3.13. Design notes are in docs/superpowers/specs.

Clean-room rule: contributions must not contain parameters, code sets or schemas derived from any employer's or institution's non-public systems or data.

License

Apache-2.0

Release files for creforge 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for creforge 0.2.0
File Size Uploaded
creforge-0.2.0.tar.gz 141.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for creforge 0.2.0
File Interpreter ABI Platform
creforge-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 183.8 kB

Release files / creforge-0.2.0.tar.gz

Download URL creforge-0.2.0.tar.gz
Size 141.2 kB
Tags Source
SHA-256 checksum
How to use checksums
0900cc3c8e587aa6b6a439d0998110f7ed195d7d67bba4ba1ada994ab45b2e4b
BLAKE2b-256 checksum
How to use checksums
db4f77e02fa75929e16e43a1668904cc9051307844ddecf681c7d384a856ebcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / creforge-0.2.0-py3-none-any.whl

Download URL creforge-0.2.0-py3-none-any.whl
Size 42.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1b1b3bfa5ac12f5621449089fd6d8c0fc1de27753f528e2b536afefbb3923b07
BLAKE2b-256 checksum
How to use checksums
f191ff0fd96c6777e3bca5b07ff831853e587d2d2b782b1c731cd89ccd3400cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page