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


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.107.tar.gz (3.3 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.107-cp310-abi3-win_amd64.whl (14.1 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.107-cp310-abi3-musllinux_1_2_x86_64.whl (13.5 MB view details)

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

gamfit-0.1.107-cp310-abi3-musllinux_1_2_aarch64.whl (11.8 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.107-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (13.4 MB view details)

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

gamfit-0.1.107-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (11.6 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.107-cp310-abi3-macosx_11_0_arm64.whl (11.4 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.107-cp310-abi3-macosx_10_12_x86_64.whl (12.8 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.107.tar.gz
  • Upload date:
  • Size: 3.3 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.107.tar.gz
Algorithm Hash digest
SHA256 eaace7024b6821862c8c01b9e7a76324fb9082de84e1986b3c2be749a9e009f6
MD5 1fabc7363eff0a0ef1ee9467540de398
BLAKE2b-256 4872938da2e6afc65dbb0e69337cf6c14bb860bd2386f27844d93fce2218dbb9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.107-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 14.1 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.107-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 375f52c700d66edac4db32da2f93faf734ac1a9ef32350051d26aaa8bea426bc
MD5 63683937ff1cdb4f05561048405923ba
BLAKE2b-256 14fb199b3a2a1f30514e04250a9c19ab2d7f497f94d64369d05a40f45fc77dcf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.107-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 064d1148370f6a8ce1fad2dac5d190d77b24794aa7223698d5103ef8ceac9e5e
MD5 c066c6a07fa5dab7d9773f90328d362f
BLAKE2b-256 ef0b7cce893e01943e2066bbb0167bbd9f6800f021b73e4d07f855f9dd85c3fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.107-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 676d172cd8fa8dd8a271a939dff53175d5148506c94886958f25d58474726b5f
MD5 e7699238ba5752d1534632ba596272fa
BLAKE2b-256 8419abe8aa7ffba8a7436b5e5f3a75cc3fb766bf099a91f1f18c3eb0e55f01cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.107-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7c987e7fe1916eb4c2e643c64a903b2dcfbfdae8b592f9b20c91d4c9a2a4715f
MD5 10e7e91c39fb1eb32f7bc3a80854de18
BLAKE2b-256 4a2b7e1ea418a5bd982745f3880a3277f8bc9cfd91af1477b26486f797ec35e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.107-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 80702d321ef8ae247a9451f6e6a5388815d7a4b7204917b818c72e9c2c7b4152
MD5 81156798cad8bdf24774b0f46a12e1e9
BLAKE2b-256 2d166d7ee9a3bce8d2d99260a966f0f77dbacf41501826c14595fd9295373a43

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.107-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cb4c2d678c83b92f0038c69d88d5681cab1927a0dc8613ca1dbc3800444c9297
MD5 73017f5f9f57f39e3f7630a1bc37206f
BLAKE2b-256 a138553bcdb5918abc7b54f687a53a41a031a12b4bcfb6191f5d9d980d9b806a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.107-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b9cc4e65cb565cd68dbe702bb2247cffcfdf723dfe70fbeddf6794223b6fea81
MD5 80a549072647c5561a4672b1bda0e675
BLAKE2b-256 cd0b1ade69d240b832429f4a60b0dea3987f2a5133217913455259995a5ee41f

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