API alias reference

PyMixEF keeps several concise, domain-familiar, and compatibility-oriented names. This page gives every deliberate public alias a searchable anchor and maps it to the canonical object whose generated API entry contains the full signature and behavior.

Aliases are not marked as deprecated. The canonical name is used here only to avoid duplicating the same implementation documentation.

Root-package conveniences

pymixef.cov

Canonical object: pymixef.covariance
Kind: module alias

pymixef.cov and pymixef.covariance refer to the same covariance module. See pymixef.covariance.

pymixef.load

Canonical object: pymixef.results.FitResult.load
Kind: callable bound-classmethod alias

pymixef.load(path, *, verify_integrity=True, require_sidecar=False) is bound directly to FitResult.load. It is not an independent module-level function; loading through either spelling performs the same result deserialization and integrity checks. See pymixef.results.

import pymixef

result = pymixef.load("fit.json")
# Equivalent public spelling:
same_result = pymixef.FitResult.load("fit.json")

pymixef.pattern_mixture_adjust

Canonical object: pymixef.data.pattern_mixture_adjust()
Kind: root-package re-export

Applies an audited response-scale delta only to cells explicitly marked as imputed and returns PatternMixtureResult.

pymixef.approximation_sensitivity

Canonical object: pymixef.compare.approximation_sensitivity()
Kind: root-package re-export

Runs named fit-setting scenarios and constructs an aligned parameter/objective sensitivity table with explicit failure accounting.

pymixef.group_influence

Canonical object: pymixef.diagnostics.group_influence()
Kind: root-package re-export

Deletes complete grouping levels, refits, and optionally compares a caller-supplied approximation against each full refit.

Data and formula aliases

pymixef.data.InputAdapter

Canonical object: pymixef.data.adapt_data
Kind: function alias

Despite its capitalized spelling, InputAdapter is the same function object as adapt_data; the object-oriented namespace is the separate DataAdapter class. See pymixef.data.

pymixef.data.prepare_data

Canonical object: pymixef.data.audit_data
Kind: function alias

This data-layer name produces AuditedData. Do not confuse it with the separate low-level pymixef.backends.base.prepare_data function. See pymixef.data.

pymixef.formula.dry_run

Canonical object: pymixef.formula.compile_formula
Kind: function alias

dry_run compiles and audits formula design matrices without fitting. See pymixef.formula.

Covariance aliases

pymixef.covariance.get_covariance

Canonical object: pymixef.covariance.covariance_structure
Kind: function alias

Both names construct a built-in or registered covariance structure by name. See pymixef.covariance.

pymixef.covariance.DiagonalCovariance

Canonical object: pymixef.covariance.Diagonal
Kind: class alias

Both names construct the same diagonal covariance class.

pymixef.covariance.UnstructuredCovariance

Canonical object: pymixef.covariance.Unstructured
Kind: class alias

Both names construct the same unstructured covariance class.

pymixef.covariance.CompoundSymmetryCovariance

Canonical object: pymixef.covariance.CompoundSymmetry
Kind: class alias

Both names construct the same compound-symmetry covariance class.

pymixef.covariance.AR1Covariance

Canonical object: pymixef.covariance.AR1
Kind: class alias

Both names construct the same AR(1) covariance class.

pymixef.covariance.HeterogeneousAR1Covariance

Canonical object: pymixef.covariance.HeterogeneousAR1
Kind: class alias

Both names construct the same heterogeneous AR(1) covariance class.

pymixef.covariance.ToeplitzCovariance

Canonical object: pymixef.covariance.Toeplitz
Kind: class alias

Both names construct the same Toeplitz covariance class.

pymixef.covariance.HeterogeneousToeplitzCovariance

Canonical object: pymixef.covariance.HeterogeneousToeplitz
Kind: class alias

Both names construct the same heterogeneous Toeplitz covariance class.

pymixef.covariance.AnteDependenceCovariance

Canonical object: pymixef.covariance.AnteDependence
Kind: class alias

Both names construct the same ante-dependence covariance class.

pymixef.covariance.SpatialPowerCovariance

Canonical object: pymixef.covariance.SpatialPower
Kind: class alias

Both names construct the same spatial-power covariance class. Full covariance class documentation is in pymixef.covariance.

Family class aliases

All aliases in this section are defined by pymixef.families.

pymixef.families.Normal

Canonical object: pymixef.families.Gaussian
Kind: class alias

pymixef.families.Student

Canonical object: pymixef.families.StudentT
Kind: class alias

pymixef.families.Lognormal

Canonical object: pymixef.families.LogNormal
Kind: class alias

pymixef.families.InverseGauss

Canonical object: pymixef.families.InverseGaussian
Kind: class alias

pymixef.families.NegativeBinomial

Canonical object: pymixef.families.NegativeBinomial2
Kind: class alias

pymixef.families.NB1

Canonical object: pymixef.families.NegativeBinomial1
Kind: class alias

pymixef.families.NB2

Canonical object: pymixef.families.NegativeBinomial2
Kind: class alias

pymixef.families.GenPoisson

Canonical object: pymixef.families.GeneralizedPoisson
Kind: class alias

pymixef.families.ConwayMaxwellPoisson

Canonical object: pymixef.families.COMPoisson
Kind: class alias

pymixef.families.ZeroInflatedFamily

Canonical object: pymixef.families.ZeroInflated
Kind: class alias

pymixef.families.HurdleFamily

Canonical object: pymixef.families.Hurdle
Kind: class alias

pymixef.families.TruncatedFamily

Canonical object: pymixef.families.Truncated
Kind: class alias

pymixef.families.CensoredFamily

Canonical object: pymixef.families.Censored
Kind: class alias

pymixef.families.ExponentialSurvival

Canonical object: pymixef.families.Exponential
Kind: class alias

pymixef.families.WeibullSurvival

Canonical object: pymixef.families.Weibull
Kind: class alias

pymixef.families.GompertzSurvival

Canonical object: pymixef.families.Gompertz
Kind: class alias

pymixef.families.LogLogisticSurvival

Canonical object: pymixef.families.LogLogistic
Kind: class alias

Family method compatibility names

These are callable method spellings on pymixef.families.Family. The forwarding methods retain the same family-specific probability or random-generation semantics as their canonical counterparts.

pymixef.families.Family.log_probability

Canonical operation: pymixef.families.Family.log_prob
Kind: callable forwarding-method alias

pymixef.families.Family.logpdf

Canonical operation: pymixef.families.Family.log_prob
Kind: callable SciPy-style forwarding-method alias

pymixef.families.Family.logpmf

Canonical object: pymixef.families.Family.logpdf
Kind: callable method alias

pymixef.families.Family.random

Canonical operation: pymixef.families.Family.rvs
Kind: callable forwarding-method alias

Backend aliases

pymixef.backends.LMMBackend

Canonical object: pymixef.backends.lmm.GaussianLMMBackend
Kind: class alias

The same alias is also available as pymixef.backends.lmm.LMMBackend. See pymixef.backends.lmm.

pymixef.backends.lmm.LMMBackend

Canonical object: pymixef.backends.lmm.GaussianLMMBackend
Kind: class alias

This is the owning-module spelling of the pymixef.backends.LMMBackend re-export.

pymixef.backends.DenseLMMBackend

Canonical object: pymixef.backends.lmm.GaussianLMMBackend
Kind: class alias

The same alias is also available as pymixef.backends.lmm.DenseLMMBackend.

pymixef.backends.lmm.DenseLMMBackend

Canonical object: pymixef.backends.lmm.GaussianLMMBackend
Kind: class alias

This is the owning-module spelling of the pymixef.backends.DenseLMMBackend re-export.

pymixef.backends.GLMMBackend

Canonical object: pymixef.backends.glmm.LaplaceGLMMBackend
Kind: class alias

The same alias is also available as pymixef.backends.glmm.GLMMBackend. See pymixef.backends.glmm.

pymixef.backends.glmm.GLMMBackend

Canonical object: pymixef.backends.glmm.LaplaceGLMMBackend
Kind: class alias

This is the owning-module spelling of the pymixef.backends.GLMMBackend re-export.

pymixef.backends.mmrm.estimated_marginal_means

Canonical object: pymixef.backends.mmrm.linear_inference
Kind: function alias

pymixef.backends.mmrm.contrasts

Canonical object: pymixef.backends.mmrm.linear_inference
Kind: function alias

Both MMRM names expose the same labeled linear-inference calculation. See pymixef.backends.mmrm.

IR and error aliases

pymixef.ir.IR_SCHEMA_VERSION

Canonical constant: pymixef.ir.MODEL_IR_SCHEMA_VERSION
Kind: constant alias

Both names contain the current model-IR schema version. See pymixef.ir.

pymixef.ir.ModelIR.hash

Canonical property: pymixef.ir.ModelIR.semantic_hash
Kind: property alias

Both properties return the SHA-256 digest of the canonical mathematical representation. Neither spelling is called with parentheses.

pymixef.ir.model_diff

Canonical object: pymixef.ir.diff_models
Kind: function alias

Both names compare two ModelIR objects and return a ModelDiff.

pymixef.errors.UnsupportedEngineError

Canonical object: pymixef.errors.EngineCompatibilityError
Kind: exception-class alias

Both names identify the same exception class. See pymixef.errors.

Pharmacometric declaration aliases

pymixef.pharmacometrics.d

Canonical operation: pymixef.pharmacometrics.derivative
Kind: callable short-form wrapper

d(state, expression) delegates to derivative(state, expression). Both are defined by pymixef.pharmacometrics.dsl.

pymixef.pharmacometrics.dsl.d

Canonical operation: pymixef.pharmacometrics.dsl.derivative
Kind: callable short-form wrapper

This is the owning-module spelling of the pymixef.pharmacometrics.d re-export.

pymixef.pharmacometrics.saem

Canonical object: pymixef.pharmacometrics.experimental_saem
Kind: function alias

The alias is also available as pymixef.pharmacometrics.estimation.saem. It is the same callback-driven experimental kernel and does not imply an integrated population estimator. See pymixef.pharmacometrics.estimation.

pymixef.pharmacometrics.estimation.saem

Canonical object: pymixef.pharmacometrics.estimation.experimental_saem
Kind: function alias

This is the owning-module spelling of the pymixef.pharmacometrics.saem re-export.

Closed-form PK aliases

The following aliases are defined by pymixef.pharmacometrics.pk and are also re-exported from pymixef.pharmacometrics.

pymixef.pharmacometrics.one_compartment_bolus

Canonical object: pymixef.pharmacometrics.one_compartment_iv_bolus
Kind: function alias

The owning-module spelling is pymixef.pharmacometrics.pk.one_compartment_bolus.

pymixef.pharmacometrics.pk.one_compartment_bolus

Canonical object: pymixef.pharmacometrics.pk.one_compartment_iv_bolus
Kind: function alias

pymixef.pharmacometrics.one_compartment_iv_infusion

Canonical object: pymixef.pharmacometrics.one_compartment_infusion
Kind: function alias

The owning-module spelling is pymixef.pharmacometrics.pk.one_compartment_iv_infusion.

pymixef.pharmacometrics.pk.one_compartment_iv_infusion

Canonical object: pymixef.pharmacometrics.pk.one_compartment_infusion
Kind: function alias

pymixef.pharmacometrics.two_compartment_bolus

Canonical object: pymixef.pharmacometrics.two_compartment_iv_bolus
Kind: function alias

The owning-module spelling is pymixef.pharmacometrics.pk.two_compartment_bolus.

pymixef.pharmacometrics.pk.two_compartment_bolus

Canonical object: pymixef.pharmacometrics.pk.two_compartment_iv_bolus
Kind: function alias

pymixef.pharmacometrics.two_compartment_iv_infusion

Canonical object: pymixef.pharmacometrics.two_compartment_infusion
Kind: function alias

The owning-module spelling is pymixef.pharmacometrics.pk.two_compartment_iv_infusion.

pymixef.pharmacometrics.pk.two_compartment_iv_infusion

Canonical object: pymixef.pharmacometrics.pk.two_compartment_infusion
Kind: function alias

On this page
Show Source