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

# Smooth fits need enough rows for the basis to be identified; ~20 rows
# is the minimum the default `s(x)` basis (cubic B-spline) is well-posed
# on. Use more rows when the signal is noisier.
train = [
    {"y": 1.05, "x": 0.0}, {"y": 1.32, "x": 0.5}, {"y": 1.78, "x": 1.0},
    {"y": 2.41, "x": 1.5}, {"y": 3.10, "x": 2.0}, {"y": 3.95, "x": 2.5},
    {"y": 4.80, "x": 3.0}, {"y": 5.62, "x": 3.5}, {"y": 6.25, "x": 4.0},
    {"y": 6.71, "x": 4.5}, {"y": 6.94, "x": 5.0}, {"y": 6.88, "x": 5.5},
    {"y": 6.55, "x": 6.0}, {"y": 5.99, "x": 6.5}, {"y": 5.20, "x": 7.0},
    {"y": 4.30, "x": 7.5}, {"y": 3.42, "x": 8.0}, {"y": 2.65, "x": 8.5},
    {"y": 2.10, "x": 9.0}, {"y": 1.82, "x": 9.5},
]

model = gamfit.fit(train, "y ~ s(x)")
print(model.predict([{"x": 1.5}, {"x": 5.0}], 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.141.tar.gz (17.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.141-cp310-abi3-win_amd64.whl (29.0 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.141-cp310-abi3-musllinux_1_2_x86_64.whl (28.5 MB view details)

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

gamfit-0.1.141-cp310-abi3-musllinux_1_2_aarch64.whl (26.5 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.141-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (28.3 MB view details)

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

gamfit-0.1.141-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (26.3 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.141-cp310-abi3-macosx_11_0_arm64.whl (25.7 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.141-cp310-abi3-macosx_10_12_x86_64.whl (27.4 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.141.tar.gz
  • Upload date:
  • Size: 17.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.141.tar.gz
Algorithm Hash digest
SHA256 aa986e408bc09cda9b8ad538cb263782305425f7ad53960d53e72e687c2bb174
MD5 33c5d26d90c1f84c4a7081ddbbef8a25
BLAKE2b-256 c98242a96a702b1746793a64561a9a69fab7b88d4410da58183f38b7522bc246

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.141-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 29.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.141-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 5b1d45ccda37b6a04d2c331b5a5a5e3313437c1a92aa87355e4a8af51c3d0747
MD5 2e7c7c04ba2a9583f4eb5071052aa7c5
BLAKE2b-256 0ae313919a26c4e00ebe869f1bcf83e6d23162a5e313809cb617280425ca6ca3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.141-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 847956f0546f92a3e61afe71b5756b40ec5ad295a4904fbfd727a89e5d828a55
MD5 3245bb4576c955287e02e1e7e13ad41a
BLAKE2b-256 153a4c654b549fa92a82e6c6801a1129b92924552f001f42cc98573aec09b1fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.141-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 fbbd39956362847379cbeccfa089cf0cdf8091ad600ff9de67057f1fe232a414
MD5 9b021576457bbdddde90b0aa88baa4cd
BLAKE2b-256 7b46506f747365b530e2c34dd0a6dd7a39f5f13de62497eb723a219e52c9093a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.141-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2915b187142c47178d4bdaaf1dffe68ab795239372bdd16fe3b3c9de0358669a
MD5 846e8cd10dfd8673bd21696edb800c84
BLAKE2b-256 c768fcf1069b9ee59dfd66c7b95f684546ec5bc751d7a8afbee8867847f8d7e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.141-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 a3cc58c1d273c610011ac8433a702a90bdf28207327762601462a2ac6c568aa5
MD5 2fb6f128e6571b3b9245d97e6eb7ee74
BLAKE2b-256 74ef4793ddd5e43b7dc3351438df30be3a0069cac97b6839ef2a71af21d605d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.141-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e7ae15ef3559937f4bc450c87dac6e271c1a8d45cdd4618f5a75a851cdb57732
MD5 0b93dc470afaf50c4145f3e761030207
BLAKE2b-256 19a182d6e3ba6d68abda136dad0f84445962e243542782a390474e7fbc57577d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.141-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 bc2ba5fc0950d0eda1a8aece2af93dc23cb27eeddd5dc33ee87d46d0de7bb0dd
MD5 898dfdc7243cdcfd352d35e0c4f90b78
BLAKE2b-256 43067d62cd2366f5e035ed5246ac3b671d81a2e201ac16925836a36efd9a190f

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