oryx.core.state.function.FunctionModule

Encapsulates a staged function.

Inherits From: Module, Pytree

oryx.core.state.function.FunctionModule(
    variables: oryx.experimental.matching.jax_rewrite.Bindings,
    jaxpr: jax_core.ClosedJaxpr,
    in_tree: Any,
    out_tree: Any,
    *,
    name: Optional[str] = None
)

Methods

call

View source

call(
    *args, **kwargs
)

call_and_update

View source

call_and_update(
    *args, **kwargs
)

flatten

View source

flatten()

replace

View source

replace(
    *, variables=None
)

unflatten

View source

@classmethod
unflatten(
    data, variable_vals
)

update

View source

update(
    *args, **kwargs
)

variables

View source

variables()

__call__

View source

__call__(
    *args, **kwargs
) -> Any

Emulates a regular function call.

A Module's dunder call will ensure state is updated after the function call by calling assign on the updated state before returning the output of the function.

Args
*args	The arguments to the module.
**kwargs	The keyword arguments to the module.

Returns
The output of the module.