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.128.tar.gz (4.0 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.128-cp310-abi3-win_amd64.whl (16.2 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.128-cp310-abi3-musllinux_1_2_x86_64.whl (15.5 MB view details)

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

gamfit-0.1.128-cp310-abi3-musllinux_1_2_aarch64.whl (13.5 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.128-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.2 MB view details)

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

gamfit-0.1.128-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (13.3 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.128-cp310-abi3-macosx_11_0_arm64.whl (13.0 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.128-cp310-abi3-macosx_10_12_x86_64.whl (14.7 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.128.tar.gz
  • Upload date:
  • Size: 4.0 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.128.tar.gz
Algorithm Hash digest
SHA256 d95fc98f0785b8cc8acb337391f2b05ae0ce3f94daab1ffd5f8b4ad2383f22cb
MD5 d465dfbc961cf456d9a6509422e66265
BLAKE2b-256 7235d99b636eab29f02a4318b455b559932d76354f145b28c3c8df695a424c48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.128-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 16.2 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.128-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 c599a3021dbd0451632912644108256a4fcc26d35dd71a9cabbb1c0e2d4f942a
MD5 fa21da890bcf061be31e7715e37fa203
BLAKE2b-256 b99ad3603471434ad141754f01a47bb9198615959c878c1c9646729b21f0b647

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.128-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 be508fcaf9a2cfe6a00e1b846958f63d7c25358ffb8c19f251d7667c695ebdaf
MD5 c310bccd70e8e0f8897be1c349b245ab
BLAKE2b-256 ab11f580e965148e306e9766cc988a89cfce7cf95a8fe0d058645b8251c39757

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.128-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 231ec7debc370d6770bc126e92b4d8c0b2bb735a1dad1c80a432036ada7557bc
MD5 b36224d0820d5842eee671e8b01cc8ce
BLAKE2b-256 079a2738fafc57f4de73ddbfe10820cafe0d3dbdbbd53297785b339d7420f746

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.128-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 531c6abe281cd1424b60d09ff416cfd03dd58bf09c83191e5f6c8c820167e087
MD5 cd7ab825514f7f94589da0658451994f
BLAKE2b-256 ec8a2ec86b7fbfa0aa9d77e329a2fd428a05d01af06151b7e5151726ce786f30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.128-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 4d57cc1310f751e10ed65f1033265d2545f7616bae54f09182dd30bd4cec158c
MD5 7ee20d8de20ef216fa5f0fa2a825e36c
BLAKE2b-256 36396d929ef2ef09115bbd970c5de8236a302c32c765e8bea5f2eeb838c59a76

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.128-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 42afac92b532558ae6e4a237be693ed9b71eab621fabbc04b0597875f14ee305
MD5 de9da9930e12d80b423076b8fce7eae6
BLAKE2b-256 ceeff90e0bc568f4c25aea3b5f1bbf3dc3c979ef35a63a8fa83f9ef5e9d95263

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.128-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d52ed26f46c149b566e49e81dd2d955d71084b24ef8a15b555e640fffae415f1
MD5 f8beef3436a490a082eacd33d2c2772b
BLAKE2b-256 bf700019582bf01a7c9afd025be29efbf72207de2ec93e11ce9b3965900cad17

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