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.117.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.117-cp310-abi3-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.117-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.117-cp310-abi3-musllinux_1_2_aarch64.whl (12.3 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.117-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.117-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.1 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.117-cp310-abi3-macosx_11_0_arm64.whl (11.9 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.117-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.117.tar.gz.

File metadata

  • Download URL: gamfit-0.1.117.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.117.tar.gz
Algorithm Hash digest
SHA256 b1728b06ef141ce0bae6cb1f2644ca4825e23fb6486af78345c4cbd15f339cb0
MD5 daca19a197a1ff4b4a5d1509863e375c
BLAKE2b-256 d581880cd202e6bfea3bfdf76a3a0fa65c38e00d31788126e740a682bf05bcd2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.117-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.117-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d2a6c408d450f5a40437946c4582347018cac337ae184438b706d98e31cace56
MD5 bfb327212550c7a17f934d130eb143ec
BLAKE2b-256 7d3c1769bbde7e41342cafa1d14da9db69b160ad907a2dd90ee4f5a09fe4f3e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.117-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 6ea0dd398c29ec386b768b4ee8d5fb458e43ebd2006570f2c3f9a51805691de4
MD5 edf28e00311c55a9819889c37eb79eac
BLAKE2b-256 eaf67b80f72b9b881bc6d7c98a429c13933c30b59735faf736b3b823ca8d9f92

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.117-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 5bc3dc859514d46dd2907874e067ce39fbea0774c667f53259ebeaa1042ebe4c
MD5 e11263b880c399d1fd13e0fc84d8021c
BLAKE2b-256 fdd03a21837b0caa9388897fd3c2cf68dc74f815e6c8f3980409a7196923fb60

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.117-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 676f1213a0f65c4d7dcc30aa12c0bd8a253ebfb0cdb92d4d4319a15c1769fc98
MD5 664b130646efafacc4548163a1fc6ece
BLAKE2b-256 2238db3c57e11eef4c2042bc0e9d3d8322177913e9e5aefdc669222491886ffa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.117-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 9384d5d4862e6fdff4c3bd97440925c415a65d06a384e8ab0e02af8cb26077c4
MD5 acd1167a15558e803c3e9581afb1d914
BLAKE2b-256 9687eedfa3680101d564e2ada6808ce2583e50208f04aad60bb6d64055780bc3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.117-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 20c058fe6b332feac56c910f4e1e801cdddd0da196bd3b53aad93654262b5057
MD5 7892cc3b7de1eeda19be68cc5edf1051
BLAKE2b-256 afc5ab90e8aab3067862a86ce47c537d97fba7dbdd687266377eab075ce26727

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.117-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a20571529cdb4be43c734cba7cb8cdb075a4194ba48622062f9b6ccd2e801536
MD5 a010a1558e225ec19319de798eaf59a9
BLAKE2b-256 dd29794b43955a7dcc3bf5c40d178a6d839a56ac15cbca92397014348099bbd6

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