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.122.tar.gz (3.7 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.122-cp310-abi3-win_amd64.whl (15.6 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.122-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.122-cp310-abi3-musllinux_1_2_aarch64.whl (12.9 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.122-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.6 MB view details)

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

gamfit-0.1.122-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.7 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.122-cp310-abi3-macosx_11_0_arm64.whl (12.5 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.122-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.122.tar.gz.

File metadata

  • Download URL: gamfit-0.1.122.tar.gz
  • Upload date:
  • Size: 3.7 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.122.tar.gz
Algorithm Hash digest
SHA256 bfdc84c88937a317fbb4c9d6803fa1839e468617546c0e28cf8fcfac58bb9a16
MD5 2d88f0842ae08ad30667c6babd542672
BLAKE2b-256 5f1d6188ca209c2f349c8f1f851dd5f8cf01c805d895407f12257fe95cb0a7d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.122-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 15.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.122-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 b02b92655e7b5584b0147a79ed151103382c52399e21110031452b34170e4ebd
MD5 cc3148912168aafc68be70aaeb921419
BLAKE2b-256 2d78570951f3e5101d4d918d720469fc6904379fef463b03d46a9030915f98dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.122-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 3bed43d1f2d56942f2e3af81c621c8cc6545eb553fb4c3b759896a81c85df8a2
MD5 690306ac034f1b6919d3ba30b96708b1
BLAKE2b-256 cbdbfcebe9703e51b421d099ddfd9aa7f6d4192e37b819a715cb1236826eb28f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.122-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 fb00e05443a17984c1935f8727b555fee8bf1b0b3bad76ad99695fd62cb733d0
MD5 1171c9d935e5d8c593e5ca2059474559
BLAKE2b-256 700982148b496b2088ddc3d80066ba23bd1d5e5c0ffda9815703e58066b26280

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.122-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 71d0b2f21f74c2ba161b6c57dfa540b887a47cc38c82cec247a59697772ddd45
MD5 9ae16d711f770cf0d5df2d7c1a2ab727
BLAKE2b-256 26d8ed389bdf245dadfd2c30161b56a0f2e1e1d903946a48654a8b3509e27deb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.122-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 d46e811cc5ef127f9613eb290a1950471c2e21d661662e0ae4fe193216f3b1f8
MD5 48c655b780a9867358bc6e8aaff4a2ee
BLAKE2b-256 961e7d5cfe341fe4e721c89dd8fadd04aa3c306b0cacadb19e1d3ab340f7dd14

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.122-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1c90a164e60cf78e0b61d8964fa6011b368ded20816fa6577fa5bfc7f09fb51b
MD5 e5ddba8a5795a382a7c9ac2414556a46
BLAKE2b-256 29e9db094dbff3205f47afbc9d889a16f80a6892628d0accc539ddd8c126cbbf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.122-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f3d2f3031877526068e175c4b4c6b5cebb8e089f669fc6a2b11761d637381a74
MD5 549895072285c6dcde9426a7fca3e7ef
BLAKE2b-256 6667f45f5518bae4a3cd8e500346d620d42b5f44c3391f898adee0c2f33bc30f

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