Skip to main content

Nonlinear multilevel spline modeling

Project description

# MultiSpline for Python

Nonlinear multilevel spline modeling for Python.

Version License: MIT Python

Version: 0.1.0 (development release) License: MIT PyPI: coming Summer 2026


Motivation

Nonlinear relationships are common in applied research, especially in education, health, and economics. While Python provides statsmodels for mixed-effects models and patsy for spline construction, combining these tools requires multiple steps and manual postestimation. multispline addresses this gap by providing a unified workflow that integrates spline construction, multilevel estimation, ICC computation, prediction, and visualization into a single interface, improving workflow efficiency and reproducibility.


Installation

Development version (GitHub):

pip install git+https://github.com/causalfragility-lab/MultiSpline-Python.git

PyPI (coming Summer 2026):

pip install multispline

Dependencies:

pip install numpy pandas scipy statsmodels patsy matplotlib

Quickstart

from multispline import MultiSpline
import pandas as pd

model = MultiSpline(
    data=df,
    outcome="math",
    predictor="ses",
    cluster="school_id",
    nknots=4
)
model.fit()
model.summary()
model.plot()

Examples

Example 1: Education — SES and math achievement

import numpy as np
import pandas as pd
from multispline import MultiSpline

np.random.seed(42)
n_schools = 20
n_per_school = 50
n = n_schools * n_per_school

school_id = np.repeat(np.arange(n_schools), n_per_school)
ses = np.random.normal(0, 1, n)
school_effect = np.random.normal(0, 3, n_schools)[school_id]
math = 50 + 0.9*ses - 0.25*ses**2 + school_effect + np.random.normal(0, 2, n)

df = pd.DataFrame({
    "math": math,
    "ses": ses,
    "school_id": school_id
})

model = MultiSpline(
    data=df,
    outcome="math",
    predictor="ses",
    cluster="school_id",
    nknots=4
)
model.fit()
model.summary()
model.plot()

Example 2: Labor economics — age and wage

np.random.seed(123)
n = 2000
n_industries = 12

industry = np.random.randint(0, n_industries, n)
age = np.random.uniform(34, 46, n)
ind_effect = np.random.normal(0, 1.5, n_industries)[industry]
wage = (8 + 0.1*age - 0.003*age**2 +
        ind_effect + np.random.normal(0, 4, n))

df = pd.DataFrame({
    "wage": wage,
    "age": age,
    "industry": industry
})

model = MultiSpline(
    data=df,
    outcome="wage",
    predictor="age",
    cluster="industry",
    nknots=4,
    autoknots=False
)
model.fit()
model.summary()
model.plot()

# Grid prediction
grid = model.predict(grid=True, n_grid=100)
print(grid.head())

Workflow

multispline automates five steps in a single interface:

  1. Knot placement at quantiles of predictor distribution
  2. Natural cubic spline basis construction via patsy
  3. Multilevel model estimation via statsmodels MixedLM
  4. ICC computation from variance components
  5. Grid-based prediction and visualization

Optimization uses robust fallback: lbfgs → bfgs → cg.


Options

Parameter Description
outcome Outcome variable name (str)
predictor Predictor variable name (str)
cluster Grouping variable name (str)
nknots Number of spline knots (default=4)
autoknots Auto-select knots 4-7 via floor(sqrt(n))

Methods

Method Description
.fit() Fit the model
.summary() Print model summary and ICC
.predict() Return fitted values
.predict(grid=True) Return grid DataFrame
.plot() Visualize nonlinear fit

Requirements

  • Python 3.8 or later
  • Predictor variable must be continuous
  • Sufficient between-cluster variability required

Limitations

  • Predictor variable must be continuous
  • Performance depends on sufficient between-cluster variability
  • Not appropriate for discrete predictors or negligible random-effects variance
  • Random-intercept only (no random slopes in v0.1.0)
  • Continuous outcomes only

Related Packages

Language Package Repository
R MultiSpline https://github.com/causalfragility-lab/MultiSpline
Stata multispline https://github.com/causalfragility-lab/MultiSpline-Stata
Python MultiSpline-Python this repo

Author

Subir Hait Michigan State University haitsubi@msu.edu RePEC: https://authors.repec.org/pro/pha1643 GitHub: https://github.com/causalfragility-lab


License

MIT © Subir Hait


Citation

If you use multispline in your research, please cite:

Hait, Subir. 2026. MultiSpline for Python: Nonlinear multilevel
spline modeling. Version 0.1.0.
https://github.com/causalfragility-lab/MultiSpline-Python

BibTeX:

@software{hait2026multisplinepy,
  author  = {Hait, Subir},
  title   = {MultiSpline for Python: Nonlinear multilevel
             spline modeling},
  year    = {2026},
  version = {0.1.0},
  url     = {https://github.com/causalfragility-lab/MultiSpline-Python}
}

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

multispline_python-0.1.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

multispline_python-0.1.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file multispline_python-0.1.0.tar.gz.

File metadata

  • Download URL: multispline_python-0.1.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for multispline_python-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4b71681935c5ff2ad7a9f6c318cc898cf0e40455b64fd6d91f286dcef210a1ad
MD5 a67f79de8587d9da252c5535b4d269ca
BLAKE2b-256 ba18dd69321b98a30716c5aca077b7296b9b81352136e5d1da8d38d50b8b2149

See more details on using hashes here.

File details

Details for the file multispline_python-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for multispline_python-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a5ffd95f0fecaf36d9e53feaeb6a624d3e345e6ae82bfa1618bca9e20a23f8c
MD5 432937910b4a68cf9a3e3bd856f041a1
BLAKE2b-256 a481b1504fb0ba1d41493c21f401763ddccadaddf2a4270b6fa5871c2af8c107

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