Skip to main content
Ctrl+K

superglm

  • Get started
  • Tutorials
  • How-to guides
  • Explanation
  • API reference
  • Governance
  • Development
  • GitHub
  • PyPI
  • Get started
  • Tutorials
  • How-to guides
  • Explanation
  • API reference
  • Governance
  • Development
  • GitHub
  • PyPI

Section Navigation

  • SuperGLM
    • Build
      • superglm.SuperGLM
      • family
      • link
      • features
      • penalty
      • lambda2
      • selection_penalty
      • selection_penalty_
      • distribution_
      • theta_
    • Fit
      • fit
      • fit_reml
      • fit_path
      • refit_unpenalised
      • estimate_p
      • estimate_theta
      • bind_levels
      • clone_unfitted
    • Inference
      • summary
      • term_inference
      • simultaneous_bands
      • random_effects
      • factor_smooth
      • metrics
      • drop1
      • term_importance
      • term_drop_diagnostics
      • knot_summary
      • design_summary
      • result
    • Predict
      • predict
      • relativities
      • reconstruct_feature
    • Plot
      • plot
      • plot_data
      • plot_diagnostics
    • Diagnose
      • diagnostics
      • spline_redundancy
      • discretization_impact
      • iteration_diagnostics
      • reml_diagnostics
      • training_telemetry
    • Constrain shapes
      • apply_shape_postfit
      • monotonize
      • apply_monotone_postfit
    • Screen interactions
      • screen_interactions
    • Deploy
      • export_rating_tables
      • rating_table_payload
    • Results and records
      • PathResult
      • REMLResult
      • LambdaPolicy
      • warmup
      • ModelSummary
      • ModelMetrics
      • DiscretizationResult
      • discretization_impact
  • SuperLSS
    • Families
      • GaussianLS
      • GammaLS
      • LogNormalLS
      • NegativeBinomialLS
      • GeneralizedGammaLSS
      • GeneralizedParetoLSS
      • TweedieLSS
      • TwoPieceLogNormalLSS
      • TwoPieceNormalLSS
    • Declarations
      • BoundPredictor
      • bind_predictor
      • term
      • s
      • cat
      • re
      • ti
      • interaction
    • Fit
      • superglm.SuperLSS
      • fit
      • fit_reml
      • diagnose
      • predictors
      • family
      • FitDiagnosticReport
    • Inference
      • summary
      • term_inference
      • term_test
      • parameter_names_
      • family_
      • predictors_
      • coef_
      • coef_by_predictor_
      • covariance_
      • result_
      • smoothing_parameters_
    • Predict
      • predict
      • predict_parameters
      • predict_link
      • predict_cdf
      • predict_quantile
      • posterior_predictive
      • posterior_draws
      • posterior_bounds
    • Check the fit
      • residuals
      • residual_set
      • check
      • check_2d
      • actual_expected
      • calibration
      • scores
      • compare
    • Price and portfolio views
      • risk_curves
      • density_fan
      • parameter_spread
      • portfolio
    • Plot
      • plot
      • plot_data
      • plot_diagnostics
    • Smoothing certification and telemetry
      • smoothing_certified_
      • smoothing_convergence_reason_
      • smoothing_unresolved_upper_bound_
      • exact_face_components_
      • coefficient_curvature
      • training_telemetry
    • Save and load
      • to_bytes
      • from_bytes
    • Configuration
      • discrete
      • n_bins
      • separation
      • weight_semantics
  • Features
    • Spline
    • PSpline
    • BSplineSmooth
    • NaturalSpline
    • CubicRegressionSpline
    • PolynomialRange
    • n_knots_from_k
    • Categorical
    • OrderedCategorical
    • Numeric
    • Piecewise
    • Polynomial
    • FactorSmooth
    • RandomEffect
    • LevelGrouping
    • collapse_levels
    • Constraint
  • Families and links
    • families
    • Poisson
    • Gaussian
    • Gamma
    • Binomial
    • NegativeBinomial
    • Tweedie
    • LogLink
    • LogitLink
    • IdentityLink
    • ProbitLink
    • CloglogLink
    • CauchitLink
    • InverseLink
    • InverseSquaredLink
    • SqrtLink
    • PowerLink
    • NegativeBinomialLink
    • NBProfileResult
    • TweedieProfileResult
    • tweedie_logpdf
    • generate_tweedie_cpg
  • Penalties
    • GroupElasticNet
    • GroupLasso
    • SparseGroupLasso
    • Ridge
    • Adaptive
  • Inference results
    • TermInference
    • InteractionInference
    • RandomEffectResult
    • FactorSmoothResult
    • SplineRedundancyReport
  • Validation and diagnostics
    • cross_validate
    • CrossValidationResult
    • lorenz_curve
    • LorenzCurveResult
    • lift_chart
    • LiftChartResult
    • double_lift_chart
    • DoubleLiftChartResult
    • loss_ratio_chart
    • LossRatioChartResult
    • dispersion_test
    • DispersionTestResult
    • score_test_zi
    • ScoreTestZIResult
    • zero_inflation_index
    • ZeroInflationResult
    • vuong_test
    • VuongTestResult
  • Plotting
    • plot_term_comparison
  • Export
    • export_rating_tables
  • scikit-learn wrappers
    • SuperGLMRegressor
    • SuperGLMClassifier
  • Statistical helpers
    • psum_chisq
    • satterthwaite
    • wood_test_smooth
  • Model editor
    • edit
    • EditorSession
    • EditableTerm
    • EditRecord
  • Warnings and exceptions
    • PublicationModeError
    • NearPoissonDispersionError
    • RatingTableBaseNotRepresentableError
    • SeparationError
    • SeparationWarning
    • NBThetaBoundWarning
    • FractionalFrequencyWeightWarning
    • PriorWeightLatticeWarning
  • Internals
    • TensorInteraction
    • SplineCategorical
    • PolynomialCategorical
    • NumericCategorical
    • CategoricalInteraction
    • NumericInteraction
    • PolynomialInteraction
    • BoundTerm
    • BoundInteraction
    • Predictor
    • ConstraintSpec
    • LinearConstraintSet
    • MonotoneRepairer
    • MonotoneRepairResult
    • SmoothCurve
    • SplineMetadata
  • API reference
  • Families and links

Families and links#

Response families define the variance function and the weight semantics; links map the linear predictor to the mean. estimate_theta() and estimate_p() estimate the extra parameter those families carry and return the profile results listed here.

superglm.families

Convenience constructors for distribution families.

superglm.Poisson

Poisson distribution.

superglm.Gaussian

Gaussian distribution.

superglm.Gamma

Gamma distribution.

superglm.Binomial

Binomial (Bernoulli) distribution.

superglm.NegativeBinomial

Negative binomial (NB2) family with overdispersion controlled by theta.

superglm.Tweedie

Tweedie distribution.

superglm.LogLink

Log link: eta = log(mu), mu = exp(eta).

superglm.LogitLink

Logit link: eta = log(mu / (1-mu)), mu = expit(eta).

superglm.IdentityLink

Identity link: eta = mu, mu = eta.

superglm.ProbitLink

Probit link: eta = Phi^{-1}(mu), mu = Phi(eta).

superglm.CloglogLink

Complementary log-log link: eta = log(-log(1 - mu)).

superglm.CauchitLink

Cauchit link: eta = tan(pi*(mu - 0.5)), mu = 0.5 + arctan(eta)/pi.

superglm.InverseLink

Inverse (reciprocal) link: eta = 1/mu, mu = 1/eta.

superglm.InverseSquaredLink

Inverse-squared link: eta = 1/mu^2, mu = 1/sqrt(eta).

superglm.SqrtLink

Square-root link: eta = sqrt(mu), mu = eta^2.

superglm.PowerLink

Power link: eta = mu^p, mu = eta^(1/p).

superglm.NegativeBinomialLink

Negative binomial link: eta = log(mu / (mu + theta)).

superglm.NBProfileResult

Profile-likelihood estimate of the NB2 shape theta.

superglm.TweedieProfileResult

Profile-likelihood estimate of the Tweedie power p and dispersion phi.

superglm.tweedie_logpdf

Row log densities of Tweedie(mu, phi / w, p), 1 < p < 2 (Dunn & Smyth 2005).

superglm.generate_tweedie_cpg

Simulate Tweedie(mu, phi, p) as compound Poisson-gamma: N ~ Poisson, Y | N ~ Gamma.

previous

Constraint

next

families

© Copyright 2026, Max Hicks.