Export / Import¶

JSON-based serialization and deserialization for single and multi-motif regression models.

pyprego.export ¶

Export and load regression models.

Mirrors export.R from the R prego package. Provides JSON-based serialisation for single and multi-motif regression models.

export_regression_model(model: RegressionResult, fn: str | Path | None = None) -> dict[str, Any] | None

Export a single-motif regression model.

PARAMETER	DESCRIPTION
`model`	Fitted regression model. TYPE: `RegressionResult`
`fn`	File path to save JSON. If `None`, returns the dict instead. TYPE: `str \| Path \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`dict \| None`	If fn is `None`, returns the serialisable dict.

load_regression_model(fn: str | Path | dict) -> RegressionResult

Load a single-motif regression model from file or dict.

PARAMETER	DESCRIPTION
`fn`	JSON file path or a dict (as returned by :func:`export_regression_model`). TYPE: `str \| Path \| dict`

RETURNS	DESCRIPTION
`RegressionResult`	Loaded model with a functioning `predict()` method.

export_multi_regression(reg, fn: str | Path | None = None) -> dict[str, Any] | None

Export a multi-motif regression model.

PARAMETER	DESCRIPTION
`reg`	Multi-motif regression result. TYPE: `MultiRegressionResult`
`fn`	File path to save JSON. If `None`, returns the dict. TYPE: `str \| Path \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`dict \| None`	If fn is `None`, returns the serialisable dict.

load_multi_regression(fn: str | Path | dict)

Load a multi-motif regression model.

PARAMETER	DESCRIPTION
`fn`	JSON file path or dict. TYPE: `str \| Path \| dict`

RETURNS	DESCRIPTION
`MultiRegressionResult`	Loaded multi-motif model with `predict()` and `predict_multi()`.