ScalarFeatureOutput#

Defined in: voxatlas.features.feature_output

class voxatlas.features.feature_output.ScalarFeatureOutput(feature, unit, values)[source]#

Bases: object

Store one scalar value per aligned unit.

Parameters:
  • feature (str) – Registered feature name.

  • unit (str) – Unit level associated with the values.

  • values (pandas.Series) – Scalar values indexed by unit identifier.

Returns:

Dataclass wrapping scalar outputs.

Return type:

ScalarFeatureOutput

Notes

Scalar outputs are typically used for token-, sentence-, or conversation- level summary values.

Examples

Usage example:

output = ScalarFeatureOutput(feature="lexical.frequency.word", unit="token", values=series)
print(output.values.head())
feature: str#
unit: str#
values: Series#