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.121.tar.gz (3.6 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.121-cp310-abi3-win_amd64.whl (15.0 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.121-cp310-abi3-musllinux_1_2_x86_64.whl (14.3 MB view details)

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

gamfit-0.1.121-cp310-abi3-musllinux_1_2_aarch64.whl (12.5 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.121-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.2 MB view details)

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

gamfit-0.1.121-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.3 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.121-cp310-abi3-macosx_11_0_arm64.whl (12.1 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.121-cp310-abi3-macosx_10_12_x86_64.whl (13.6 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.121.tar.gz
  • Upload date:
  • Size: 3.6 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.121.tar.gz
Algorithm Hash digest
SHA256 6eaa276946c0d8e66d9b60e0595acee45790f3bfe315f5deb94bd6245c1a7a19
MD5 4d4535d760df578fa085b3b25ae5254e
BLAKE2b-256 4f27ab1d5e37a91e86de005de10df975c35d99d7f41fc71b9c2118f12e1aa2b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.121-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 15.0 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.121-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 34ae876436ca79b1dba04454177aeb7c2c65c7205cdf3e80d180ec4846e68afc
MD5 0a462f6ae3b7f3213b08ea19029b1262
BLAKE2b-256 e39a9149c4b79790725197fa99be1b2d96a0e39de68b9f3e1c666e3f927bc125

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.121-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 d5ce11330b63986dec91626d438bb853f6d402a0049a5ebd872c7c0234f758ef
MD5 d9a3b0374272ee56105903d5b23edbc0
BLAKE2b-256 e771fa9b32ec6075c24bc83cc9c63f8cbd5e0760ff3278abb6338fbdfdd126bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.121-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 170215dafd8fd539d3402e5e4bbb920209361012852d810bc00300e35780077b
MD5 ec4f9c3379fe19a9c674a5840cfea1a3
BLAKE2b-256 8fdd816f8b1a2dbdacde72dd5751df0206cba668a1553396ad753b632748ac44

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.121-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 03595b1099f76d791c78df4be605eb9f9f71b206afa9bc4c020dda9666ba7fae
MD5 8a40ebc5a88b06f7bbb2f25a8d6a2d7e
BLAKE2b-256 49e157dbab92c42843d60d11fc363cd77d5414b4693392ce8ed6577e23fd1d9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.121-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 475608fc146f5fd26a51fb6b313fbde709ac6ca40514bc418dc1e52cb24091df
MD5 7282c294ca970aa3e1bb8588093abc3c
BLAKE2b-256 dbd246f796d4f57dd9117e37ebb43b759130ef2110a0d6a23cda8fbc5b60a038

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.121-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d105913416038def9d7d3e670a11a898847709300b12bb60f44c1fd1ffa8001e
MD5 a7cf3673f59c62a73d47867f91486b52
BLAKE2b-256 5764d28e7bd0d066972f48a357238fce4db50a9dfb0346135e5b3b338743f29a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.121-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 8a89ad881c6218f8c6822f0d32243fee3cae678c289ed316d33108f5e1dc2177
MD5 0c3e109a5748ff15a4ecceb5d0022287
BLAKE2b-256 79f485b78778921c65db320ce7735e122557a6657a31b8c3e4e669016105945c

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