Module

class scarlet2.Module

Bases: Module

Scarlet2 base module

Derives directly from equinox.Module, i.e. from python dataclasses, and adds extra functionality to deal with optimizable parameters.

__call__()

Evaluate the model

get(name=None)

Get parameter(s) from this module

Parameters:

name (str, optional) – Name of parameter. If not set, returns all parameters.

Returns:

requested data arrays for parameters

Return type:

dict

property parameters

Parameters defined for this module

Returns:

name: (node, param) mapping for all parameters

Return type:

dict

set(values)

Set parameter(s) from this module with values

Parameters:

values (dict[str,jnp.array]) – values to replace parameters with, identified by their name

Returns:

new module with parameter(s) replaced by values

Return type:

Module