TS1ReadoutSpec#

class ibl_bwb_eval.TS1ReadoutSpec(id, dim, data_type, target_resolution, primary_metric, metrics, value_key, domain_key, interval_key, timestamp_key=None, mask_key=None, mask_counts_key=None)[source]#

Bases: object

Specification for a single decoding readout head.

Defines the target variable’s type, dimensionality, data keys, and evaluation metrics for one task in the benchmark.

id#

Unique identifier for the readout (typically the task name).

dim#

Output dimensionality of the readout head.

data_type#

Type of the target variable (continuous, binary, etc.).

target_resolution#

Whether the target is at the item or timestep level.

primary_metric#

Name of the metric used for model selection and early stopping.

metrics#

Mapping from metric name to a callable that instantiates the metric.

value_key#

Key in the data dict for the target values.

domain_key#

Key in the data dict for the domain identifier.

interval_key#

Key in the data dict for the trial intervals.

timestamp_key#

Key in the data dict for target timestamps. Optional.

mask_key#

Key in the data dict for the validity mask. Optional.

mask_counts_key#

Key in the data dict for the mask counts. Optional.

property num_timesteps: int#

Target steps the readout emits. Derived, so it cannot drift from the resolution.