mobgap.pipeline.evaluation.error#

mobgap.pipeline.evaluation.error(
df: DataFrame,
reference_col_name: str = 'reference',
detected_col_name: str = 'detected',
) → Series[source]#

Calculate the error between the detected and reference values.

Parameters:
df

The DataFrame containing the reference and detected values.

reference_col_name

The identifier of the column containing the reference values.

detected_col_name

The identifier of the column containing the detected values.

Returns:
error

The error between the detected and reference values in the form detected - reference