Signal Registry

systematica.registries.signal_registry

Variables

• SignalRegistry: Config of signal models.

SignalConfig

SignalConfig(
    title: str,
    name: str,
    runner: Callable,
    required_params: str | List[str] | None,
    default_params: str | List[str] | None,
    tags: List[str],
)

Configuration for a signal calculation.

This class encapsulates the necessary configuration for computing signals.

Method generated by attrs for class SignalConfig.

Instance variables

• default_params: str | List[str] | None: Default parameters for the metric or None.

• name: str: Function name to compute the signals.

• required_params: str | List[str] | None: List of required parameters or None.

• runner: Callable: Function to compute the signals.

• tags: List[str]: Tags associated with the metric.

• title: str: Title of the method used to calculate the signal.

Methods

run_name

run_name(
    self,
    *args,
    **kwargs,
) ‑> numpy.ndarray

Run model function.

Parameters:

Name	Type	Default	Description
args	tp.Args	--	Signal model function arguments.
kwargs	tp.Kwargs	--	Signal model function key-word arguments.

Returns:

Type	Description
tp.Array	Signal model function output.