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.108.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.108-cp310-abi3-win_amd64.whl (14.4 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.108-cp310-abi3-musllinux_1_2_x86_64.whl (13.7 MB view details)

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

gamfit-0.1.108-cp310-abi3-musllinux_1_2_aarch64.whl (12.0 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.108-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (13.6 MB view details)

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

gamfit-0.1.108-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (11.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.108-cp310-abi3-macosx_11_0_arm64.whl (11.6 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.108-cp310-abi3-macosx_10_12_x86_64.whl (13.0 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.108.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.108.tar.gz
Algorithm Hash digest
SHA256 ea67726714972302fc86b3a24d2173b21d2dafeb20d0f07bc409d882ebd56fad
MD5 3014d2567f0a04c4aca178293dc34dff
BLAKE2b-256 dfe32cc81c569b9f33071f86584f7b72ce7a9abc7b3cf2cfac84f0399e1d6e5b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.108-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 14.4 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.108-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 15421e9ce80f10ca2095775c8cfa43f03518c36b342c44b342960154bcd3b14e
MD5 6e4caf7c021ab3123a8d28ea27cd1ef4
BLAKE2b-256 ada736000db05c162d3370e71edaaab4036e6158c94302fae313612f56b8beeb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.108-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5866e84a0fe9a1f284767167f43579dd6b883d36340bf29ebd02efb09c698ad8
MD5 01f02176cb162a359290d9ea76147299
BLAKE2b-256 6d7d247a009ea274f5cc1bcfe79e323ab4d8986bd591069305dc560e83004e95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.108-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 af7f97848db9a1562cf7490ff0e53ad9ae1bf99b3aea3d78f487ed0e304747a6
MD5 3dcd5e2992295a12ae6a7464c278a16d
BLAKE2b-256 56875b0a475cdc410626521314f78c92c10fe1e4ffb72acfe0843bd514f995da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.108-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2fed106d039efe6b940d8d208a4a7de36b27b4054c9d93d07b1fcec0b44e36ef
MD5 7d7092db18e520861c4c7fcd89274623
BLAKE2b-256 e6e31f29c0110db13d1d4b87499d874f6a57d3214be0f2391e1c7e325629cbe9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.108-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 5974648a6d8c49a934d2b8a37695c8b061baae7e7a7c740e087f7850d8885432
MD5 6ea9b2e7d839c8c0fbe94f06dcb9e58b
BLAKE2b-256 6c2f08f454e80359f23198b1bd085ba85ddf0782d85849d27597abc96151dc0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.108-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7ba0f6de2e44acd9c77d78bae29936f1d9729d456c25cea6fb9d66916244dcfd
MD5 97c292ecaf0721dab631838fca8e34df
BLAKE2b-256 bc80b5903acf0560d572fd501057a36325174c68035e3910de6e84bf98c854ce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.108-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b0f46b57da8f458880ca884cf0387fad3f5e67742e4df02c74079ac5dbfa764c
MD5 9861245e4871c0a0724ee748de5f9290
BLAKE2b-256 2490df2fcf86018ff1e80a000b5591403494ea4a98354191a8b09e1d7c4e2ab7

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