Skip to main content

Weighted structured nonconvex sparse models (Python + Rust)

Project description

skein

Weighted structured nonconvex sparse models. Rust core + Python API.

Documentation: the docs site has the full conceptual reference (penalties, datafits, weights, backends), porting guides for glmnet / ncvreg / grpreg, worked examples, and an auto-generated API reference. Hosted on Read the Docs once the project is connected (config in .readthedocs.yaml); preview locally with mkdocs serve. CI builds it --strict on every PR.

skein targets a niche that's well-served in R (grpreg, ncvreg) but missing in Python at production quality: nonconvex group-structured penalties (group MCP, group SCAD, sparse-group nonconvex) with first-class support for weights along three axes — per-sample, per-feature, and per-group.

Status

v0.1 development. Core algorithms and the headline GLM family are in place; design-matrix backends (sparse, mmap, chunked) are next. See ROADMAP.md for the full plan.

Done so far:

  • Solvers — production CD core (path solver, strong rule + KKT verification, gap-safe screening, Anderson acceleration); group block-CD with LLA outer loop for nonconvex group penalties; Rayon-parallel group sweeps; operator-norm Lipschitz via power iteration.
  • Datafits — least squares, binomial logistic, Poisson (log link), Cox PH (Breslow ties). All glued together by a GlmDatafit trait that exposes a weighted-LS surrogate; the M1/M2 inner solvers absorb every GLM unchanged.
  • Penalties — MCP, SCAD, group lasso, group MCP, sparse-group lasso, sparse-group MCP. Per-feature and per-group weights honored throughout.
  • Python — sklearn-compatible estimators for every (datafit × penalty) combination; type stubs; warm-started λ-paths; standardization with original-scale coef_ / intercept_ recovery (dense backend).

M8 (Distribution & DX) is done: CI + cibuildwheel + Read the Docs + 25-page mkdocs site (concepts + R-porting + extending + examples + API ref) + R numerical regression suite vs glmnet/ncvreg/grpreg + stable Rust API contract. The library is pip install-able once published, documented end-to-end, and pinned against R reference fits so we don't silently drift.

Coming next: algorithmic features — M5.x adaptive weights and stability selection are the next high-value milestones; both leverage the existing per-feature/per-group weight axes that are already wired through every solver.

Layout

crates/skein-core/   pure Rust: traits + algorithms (no Python)
crates/skein-py/     PyO3 bindings (cdylib → skein_glm._core)
python/skein/        sklearn-compatible estimators + ABCs for extensions
tests/               pytest smoke tests
benches/             criterion (Rust) + asv (Python)

The Rust traits (DesignMatrix, Datafit, GlmDatafit, Penalty, GroupPenalty) and their Python ABC mirrors (skein.penalties.Penalty, etc.) are the extension surface for downstream per-paper projects.

Quick start

import numpy as np
from skein import MCPPathRegressor, LogisticGroupMCPPathRegressor, CoxMCPRegressor

# Nonconvex sparse least squares with a λ-path.
rng = np.random.default_rng(0)
n, p = 200, 50
X = rng.standard_normal((n, p))
y = X[:, :3] @ np.array([1.5, -2.0, 0.8]) + 0.1 * rng.standard_normal(n)
model = MCPPathRegressor(gamma=3.0, n_lambdas=50, standardize=True).fit(X, y)
print(model.coefs_[-1, :5], model.intercepts_[-1])

# Logistic + group MCP via LLA, with sklearn-style predict/predict_proba.
groups = np.repeat(np.arange(p // 5), 5)  # 5 features per group
y_bin = (X[:, :3].sum(axis=1) > 0).astype(float)
clf = LogisticGroupMCPPathRegressor(groups=groups, gamma=3.0, n_lambdas=20).fit(X, y_bin)
proba = clf.predict_proba(X)  # shape (n, n_lambdas)

# Cox PH with right-censored survival data.
time = rng.exponential(1.0 / np.exp(X[:, :3].sum(axis=1)))
event = rng.uniform(size=n) < 0.7
cox = CoxMCPRegressor(lambda_=0.01, gamma=3.0).fit(X, time, event.astype(float))
risk = cox.predict(X)  # prognostic index η

Every regressor follows the same (datafit) × (penalty) × ({,Path}Regressor) naming scheme. The path variants warm-start across λ; their coefs_ / intercepts_ (where applicable) are 2D arrays indexed by λ.

Build

# Rust core only (fast iteration on algorithms)
cargo test -p skein-core

# Full Python package (requires maturin in your env)
maturin develop --release
pytest

License

MIT.

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

skein_glm-0.1.1.tar.gz (135.2 kB view details)

Uploaded Source

Built Distributions

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

skein_glm-0.1.1-cp310-abi3-win_amd64.whl (1.0 MB view details)

Uploaded CPython 3.10+Windows x86-64

skein_glm-0.1.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (978.6 kB view details)

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

skein_glm-0.1.1-cp310-abi3-macosx_11_0_arm64.whl (815.6 kB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

Details for the file skein_glm-0.1.1.tar.gz.

File metadata

  • Download URL: skein_glm-0.1.1.tar.gz
  • Upload date:
  • Size: 135.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for skein_glm-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7e044aadcbe1deb29b0fd91f861b94a14ff1cc4e31ae7e7f34623041047457f7
MD5 d655a973ac6f91a538d5d68236816d20
BLAKE2b-256 03192f0f43f41d3a28047de397eea52efe88a84aec1300e0c69beea24588ccf1

See more details on using hashes here.

Provenance

The following attestation bundles were made for skein_glm-0.1.1.tar.gz:

Publisher: wheels.yml on dvillacis/skein

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skein_glm-0.1.1-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: skein_glm-0.1.1-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for skein_glm-0.1.1-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 5f68cecbe06aa0ba012241cdc53b8a63fb9007ccfb9495018c3392a31e74c9e4
MD5 2c164faf224ddead9b18c28faa2755a1
BLAKE2b-256 44e41b57b00c364dc6a9197b0200e55a592cd1a0d7a22f9387f56f227c8db0fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for skein_glm-0.1.1-cp310-abi3-win_amd64.whl:

Publisher: wheels.yml on dvillacis/skein

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skein_glm-0.1.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for skein_glm-0.1.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2c4bee7112cca420a3d5dd744883b97b53d6df1240bfc3f758f7e65fb4b773e5
MD5 cc1e0992b95806812e7bbd330b994853
BLAKE2b-256 57b4a9fab93e0b165236fa6143dd8fbfbc89508c31c472cce9519fcb885f5a21

See more details on using hashes here.

Provenance

The following attestation bundles were made for skein_glm-0.1.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: wheels.yml on dvillacis/skein

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skein_glm-0.1.1-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for skein_glm-0.1.1-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cd0536b96c58021183715d6d8832475a94bb60c42178f0666dd83c266c22ae98
MD5 38d58bcaec3bf20ab16a7527bf218621
BLAKE2b-256 21acd0cadda33fedd4314b4680ef0062b469f291ada5ca7c033696e662d60010

See more details on using hashes here.

Provenance

The following attestation bundles were made for skein_glm-0.1.1-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: wheels.yml on dvillacis/skein

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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