plima.models.model_registry

Registry for PLIMA model functions.

Functions

discover_models()	Import model modules once so decorated models are registered.
get_model(name)	Return a registered PLIMA model function.
list_model_aliases()	Return canonical model names and aliases.
list_models(*[, include_aliases])	Return registered model names.
register_ia_model(name, *[, aliases])	Register a PLIMA model function.

plima.models.model_registry.discover_models()

Import model modules once so decorated models are registered.

Return type:

None

plima.models.model_registry.get_model(name)

Return a registered PLIMA model function.

Parameters:

name (str)

Return type:

Callable[[…], ndarray[tuple[Any, …], dtype[float64]]]

plima.models.model_registry.list_model_aliases()

Return canonical model names and aliases.

Return type:

dict[str, tuple[str, …]]

plima.models.model_registry.list_models(*, include_aliases=True)

Return registered model names.

Parameters:

include_aliases (bool)

Return type:

tuple[str, …]

plima.models.model_registry.register_ia_model(name, *, aliases=())

Register a PLIMA model function.

Parameters:

• name (str)

• aliases (tuple[str, ...])

Return type:

Callable[[Callable[[…], ndarray[tuple[Any, …], dtype[float64]]]], Callable[[…], ndarray[tuple[Any, …], dtype[float64]]]]