pyextal.jaxEngine.structureModel

Attributes

Functions

register_model(name)

Decorator to register a model function with a given name.

get_model_by_name(→ Callable)

Get a model function by its registered name.

list_registered_models(→ List[str])

List all registered model names.

model_factory(→ Callable)

Create a model function with fixed parameters for a specific layer.

Module Contents

pyextal.jaxEngine.structureModel._MODEL_REGISTRY
pyextal.jaxEngine.structureModel.register_model(name: str)

Decorator to register a model function with a given name.

Usage:

@register_model(‘my_model’) def my_model_function(params, layer_idx=0):

…

pyextal.jaxEngine.structureModel.get_model_by_name(name: str) → Callable

Get a model function by its registered name.

Parameters:

name – The registered name of the model

Returns:

The model function

Raises:

ValueError – If the model name is not found in the registry

pyextal.jaxEngine.structureModel.list_registered_models() → List[str]

List all registered model names.

pyextal.jaxEngine.structureModel.model_factory(name: str) → Callable

Create a model function with fixed parameters for a specific layer.