Skip to main content

Formula-first generalized additive models with a high-performance Rust core

Project description

gamfit

PyPI Python Docs License

Formula-based generalized additive models for Python, backed by a Rust engine.

gamfit fits Gaussian, binomial (including Bernoulli marginal-slope), Poisson, and Gamma GLMs with smooth terms, random effects, bounded/constrained coefficients, location-scale extensions, survival likelihoods, and flexible/learnable links. Smoothing parameters are selected by REML or LAML. Posterior sampling uses NUTS where supported, and a Gaussian Laplace approximation otherwise.

Manifold smooths handle predictor spaces that wrap or close: circles, cylinders, tori, and the sphere (intrinsic Wahba and spherical-harmonic kernels), plus periodic tensor products and boundary-conditioned B-splines. The Möbius example in the gallery is a 4π-periodic double-cover parameterization, not a twisted Möbius-strip basis.

rotating recovery of a trefoil knot, latent-free loop, wobbly cylinder, lumpy sphere, bumpy torus, and Möbius double-cover from noisy 3-D point clouds

Docs: https://gamfit.readthedocs.io/.

Install

uv add gamfit

Wheels are published for Linux (x86_64, aarch64), macOS (x86_64, Apple silicon), and Windows. No Rust toolchain is required.

Example

import gamfit

train = [
    {"y": 1.2, "x": 0.0},
    {"y": 1.9, "x": 1.0},
    {"y": 3.1, "x": 2.0},
    {"y": 4.5, "x": 3.0},
]

model = gamfit.fit(train, "y ~ s(x)")
print(model.predict([{"x": 1.5}, {"x": 2.5}], interval=0.95))
print(model.summary())
model.save("model.gam")

pandas, polars, pyarrow, numpy, dict-of-columns, and list-of-records inputs are all accepted without conversion.

Features

  • Polyharmonic / Duchon smooths combine magnitude, gradient, and curvature penalty operators on the same basis. P-spline and thin-plate smooths use their standard derivative penalties. Each penalized block has its own smoothing parameter.
  • Flexible link functions: flexible(base) adds a spline offset on a base link; blended(...) learns a mixture weight; sas and beta-logistic learn shape parameters.
  • Surface smooths in arbitrary dimension: thin-plate, Duchon (scale-free by default, hybrid with length_scale=...), and Matérn, with automatic knot placement.
  • Manifold smooths: periodic 1-D, cylinder / torus tensor products, intrinsic sphere (Wahba kernel or spherical harmonics), and boundary-conditioned B-splines.
  • Per-axis anisotropy inside a single joint smooth.
  • Marginal-slope models that separate baseline risk from a calibrated score's effect, for Bernoulli and survival outcomes.
  • Posterior sampling via NUTS where supported, Gaussian Laplace otherwise, behind one API.

API examples

import gamfit
from gamfit.sklearn import GAMRegressor, GAMClassifier

# Validate before you fit
gamfit.validate_formula(train, "y ~ s(x) + group(site)")

# Posterior sampling and mean bands
posterior = model.sample(train, seed=42)
bands = posterior.predict(test, level=0.95)

# Survival
gamfit.fit(df,
    "Surv(entry, exit, event) ~ s(age) + bmi + timewiggle(internal_knots=6)",
    survival_likelihood="transformation",
    baseline_target="weibull",
)

# scikit-learn
est = GAMRegressor(formula="y ~ s(x)")
est.fit(X, y)

# Diagnose, plot, report
model.diagnose(train).metrics
model.plot(train, x="x", kind="prediction")
model.report("report.html")

Public API

Symbol Purpose
gamfit.fit(data, formula, **kwargs) Fit a model.
gamfit.load(path) / gamfit.loads(bytes) Reload a saved model.
gamfit.load_posterior(path) Reload a PosteriorSamples archive.
gamfit.validate_formula(data, formula, ...) Type-check a formula without fitting.
gamfit.build_info() Native extension build metadata.
gamfit.cuda_diagnostics() / gamfit.format_cuda_diagnostics() CUDA probe results.
gamfit.explain_error(exc) Human-readable hint for a gamfit exception.
gamfit.Model Fitted model: predict, summary, check, diagnose, plot, report, sample, save.
gamfit.SurvivalPrediction Per-row hazard / survival surface.
gamfit.CompetingRisksPrediction, competing_risks_cif Competing-risks CIF evaluation.
gamfit.SamplingConfig, PosteriorSamples, PosteriorPredictive, PairedPosteriorSamples Posterior interface.
gamfit.ResponseGeometryModel, sphere_frechet_mean, simplex_frechet_mean, alr, clr, closure Response-geometry utilities.
gamfit.sklearn.GAMRegressor / GAMClassifier scikit-learn estimators.

Full reference: https://gamfit.readthedocs.io/en/latest/api-reference/.

Optional extras

uv add "gamfit[pandas]"     # pandas + pyarrow input/output
uv add "gamfit[plot]"       # matplotlib-based plotting
uv add "gamfit[sklearn]"    # scikit-learn integration
uv add "gamfit[torch]"      # PyTorch bridge
uv add "gamfit[all]"        # everything

GPU acceleration

CUDA support (cuBLAS / cuSOLVER / cuSPARSE) is built into the same wheel; there is no separate gamfit-gpu package. Per-op dispatch thresholds are derived at probe time from measured GPU FP64 throughput, CPU FP64 throughput, and PCIe bandwidth, so small kernels stay on the CPU. Inspect the calibrated thresholds with gamfit.build_info()["cuda_diagnostics"] or gamfit.format_cuda_diagnostics().

If both a system CUDA toolkit and pip nvidia-*-cu12 wheels are present in the same environment, gamfit warns once per conflict-set and continues; glibc resolves dlopen(SONAME) to a single file, so this is usually benign. If you use gamfit with torch, install a torch build whose CUDA suffix matches your driver.

License

AGPL-3.0-or-later. See LICENSE.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

gamfit-0.1.120.tar.gz (3.5 MB view details)

Uploaded Source

Built Distributions

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

gamfit-0.1.120-cp310-abi3-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.120-cp310-abi3-musllinux_1_2_x86_64.whl (14.1 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ x86-64

gamfit-0.1.120-cp310-abi3-musllinux_1_2_aarch64.whl (12.4 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.120-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.0 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ x86-64

gamfit-0.1.120-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.120-cp310-abi3-macosx_11_0_arm64.whl (12.0 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.120-cp310-abi3-macosx_10_12_x86_64.whl (13.4 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file gamfit-0.1.120.tar.gz.

File metadata

  • Download URL: gamfit-0.1.120.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for gamfit-0.1.120.tar.gz
Algorithm Hash digest
SHA256 44ba86f8d6d17e19af0d590be11b1ede80bd7f873f21b255194f754cd1583c5b
MD5 d30de331302a60c9745893cac75c7fc5
BLAKE2b-256 5f3c97645cd1fe752c3b8b8ef90c0264b32edf9cc9f926b19f4bf757df9ea9eb

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: gamfit-0.1.120-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 14.8 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 9c07d1e8779415c0a81282f9c5240970c6cd14276594f8eb95bb6e55b66b092b
MD5 4c62b30a6d6c0166ec5b989822370ac4
BLAKE2b-256 0eb7ca7d0c04205081e3214cd03d44f23ff8cf8a5ec3da1483a33a08e7df4f9f

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 7f9054aad034cfd9951438ba59b1fdf920ad7deda689a07af9f05388e7128692
MD5 86484db83845724280d69182d8451a61
BLAKE2b-256 5145dc55d4a28994134433cb691a872891ec7dc1322d375723dd81cc5810792d

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 71ab9eef88b6ad4376e7d110d1a72598407317ba625fd7f6ad440ffadca0628e
MD5 7d5d3d35db8bb1be72b9ca6033dec1ae
BLAKE2b-256 0a915fce03854a1ead417094f6bfad5ff2cdf40afa34f350d9cfaab5fa7b3670

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3205c8b8324d43424c09a064d6f8a507e44f459ebd235d6d361d13b5556fff1c
MD5 f105e9a09b220841237993a0ca66bb76
BLAKE2b-256 316f5d9727cf086eaffd2b443b33dcaa6c242ba3ad73fb94b3df35107ca3d51e

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 bda05d88dc163b1f7e4e671c6bea212c29ab29f69bf06b491c4defaa81cbcb48
MD5 e5583c64ba4c1515273a79e7feb017a2
BLAKE2b-256 70c07ac1814a3d70591d01135639979f93528bd02d7b5a812d584278c0671bba

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4051b55b075986a29f60e5e06403ea76c836ddfe4500bc4968b5de02b00eedd7
MD5 859685da527231313ae5ed4f5516cac5
BLAKE2b-256 603993cb7421bfbb151727547c4c55d74d750401971dd013ee049fe22c35ace5

See more details on using hashes here.

File details

Details for the file gamfit-0.1.120-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.120-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f019a259350f9c6d527b7f38dc28d0330e83f1c359f3efbf5f6f2896ea457d3c
MD5 d4f1c2e92d01041cffb7f1d83942bd82
BLAKE2b-256 420823ddb41e9969bd5cf17b8ef9dc4d48353fdc72b19cd1c7170dcd9f501675

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