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.124.tar.gz (3.8 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.124-cp310-abi3-win_amd64.whl (15.7 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.124-cp310-abi3-musllinux_1_2_x86_64.whl (14.9 MB view details)

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

gamfit-0.1.124-cp310-abi3-musllinux_1_2_aarch64.whl (13.0 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.124-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.7 MB view details)

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

gamfit-0.1.124-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.124-cp310-abi3-macosx_11_0_arm64.whl (12.6 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.124-cp310-abi3-macosx_10_12_x86_64.whl (14.2 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.124.tar.gz
  • Upload date:
  • Size: 3.8 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.124.tar.gz
Algorithm Hash digest
SHA256 fd6837b25d24227a40245c0e767efb280aa9f1ed788425897f55c7df344addc3
MD5 7057fba844561e49bb42f829b0344751
BLAKE2b-256 4f8ac69d370099d16b07fbfe79f12fa7565a024414c77022bda65d2a3945f26c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.124-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 15.7 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.124-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 e384e54904d2c582fb80fe4604c959d3179d8aa3d6dfa953cc1c7742420ca9cf
MD5 80841fd7e0f398ff6b4a380aee42c603
BLAKE2b-256 33beac8b8c1633496ac9ce7c77309ce0dc363ce15126fe685d139db676132702

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.124-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 2a5fc64e05bc6ffee6b97e1306844838656d497abb170f62e40dfca2417d53c8
MD5 e077fea4957693efd8b0bbcbbbc2e972
BLAKE2b-256 dc50510f125a7c9f9186e805cc8aebab9014f5cace86313a2a348fa1b9c34986

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.124-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 6c45daf22aca50bd3154fcc1402d0bfa2866f8c0e5c9beaf0eeff6a7fc07d202
MD5 e1bff6ec4e6fc76d5fb7f052431ee655
BLAKE2b-256 24da0177019790667fdc16f98889f5d140ca16a2c08f1d90cd749dde474e073d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.124-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 bd9a8f1613067a8f86adaf7e8e8d0c9e8a63ec3dd10886f019dbe9a3d00f5237
MD5 f1a0f14f6d7fa9289e2a0d9891090dfe
BLAKE2b-256 dda8b5cc177f19a5997e29e3dec3b0538493ed3f9a782c0cd0b7b0bf11b0a443

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.124-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 55e8db764ded07683fb45e8bf69596fbf31c0fed4885f2a4326987974b4cdd6c
MD5 6cf823badd7ba0e81172b0b6bd64c874
BLAKE2b-256 3ab1451da956689df540d8a73a921547015d79593265c6724118974c19c446ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.124-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 321c63316e1f32ce59a9869a6cc477e9073cb3441badb6d14bd0cd0044a6aa6a
MD5 3040d3a247e07355c19293b0414016fb
BLAKE2b-256 a6a31f7c865de62059c0731b5fd786f908f5743a475cca8ddbfb322b010ea535

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.124-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 c4f7a46256f2f1ce4b88acf5597526e9da7e79f9322ac1b205b7cfdd23f29494
MD5 fc8fe076f129457d65c6c482cbd93cf8
BLAKE2b-256 d6eec2ded0fc3c5ef3ac200447227cb3870182f411dbfe316fa4d9fb0c4dbe77

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