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.134.tar.gz (16.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.134-cp310-abi3-win_amd64.whl (28.6 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.134-cp310-abi3-musllinux_1_2_x86_64.whl (28.1 MB view details)

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

gamfit-0.1.134-cp310-abi3-musllinux_1_2_aarch64.whl (26.1 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.134-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (27.8 MB view details)

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

gamfit-0.1.134-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (25.9 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.134-cp310-abi3-macosx_11_0_arm64.whl (25.3 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.134-cp310-abi3-macosx_10_12_x86_64.whl (27.0 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.134.tar.gz
  • Upload date:
  • Size: 16.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.134.tar.gz
Algorithm Hash digest
SHA256 47d29f8e4539e89be1bae2cf5e2dd52c4c5cc0eddc3526693ade06d070ff7167
MD5 53af33de326300543aaca909870ac439
BLAKE2b-256 d68c2a4badd83474ad1e8ab35d9015454949bacc978308646db5c65b98ce2e41

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.134-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 28.6 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.134-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 2212e6b50fd8e73fd08d818f93acdd2fb99c4360d5929a4f040529018e40caf9
MD5 e70414854337e9223983df89a40f9aa1
BLAKE2b-256 8e7375880500cef3d6a71d005c1b56ced9b93d243e8161b529a50086e8ec265e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.134-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 83c0e2b5567121034b2fed90cc30613548106f28c9871ca988e475c47f3c0ebb
MD5 1fd7e119aff3c42746ec3bbd1be65b0d
BLAKE2b-256 3905afa2ceb7dad4d631e5a0caa032decc7274b7c2f8677a7b07d1cb461a007a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.134-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 ac0ebec6204315605ed0c3e7ba26f592314a6dfdf1619a58687578bf7cf0dc60
MD5 bcf81ecffce9e63eeca2a108d15547be
BLAKE2b-256 c71bb44a693715b3371ca7d1d72ffbb57bd2e7206cb72b481b3d52b83465f387

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.134-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 224f2f4fa0f7570e004791b0d94276149d51ff27d826bd41677a82d6f5b5328d
MD5 e8a9ffe1fa876f1c676c4c3919c479f3
BLAKE2b-256 82b6a9891e97e314ac4e08c7fbee6f7bac8056884ddad9c171e6e3df97b0ebbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.134-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 7bfaa334ba5b8d3fa0e2dbefb533dc643df47e1a530c6e9f90d35388fa857537
MD5 1ec88d0a18e347c53221d98b534d73b3
BLAKE2b-256 c5794f967bd9c6682428a676c5286bb9c7693339d9752ef1e63ddfe9312f0b73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.134-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 02fbc543ef8dbe3c5581dbd4817cb168243a6add188b53e494308d4061d2d7c3
MD5 fd9dd99a06c39031bfac146b7117c97f
BLAKE2b-256 642db8381ea408e461918765bc4f39b2677c7c70db7f144701061a85d5b888e1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.134-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a5aa564327269a92e1e3c69ddcc1691887be1a4432f7b4534f3132d492fd4de8
MD5 ce22d4f9625af8ddf36abe5e27ba628c
BLAKE2b-256 54a8ac664c4b9918f5ec217db144539658ae6c92747401f0d1d74a395ab7dfe7

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