expected_relative_extra_from_table

er_evaluation.expected_relative_extra_from_table(error_table)

Compute expected relative extra elements from record error table.

See er_evaluation.error_analysis.expected_relative_extra().

Parameters:

error_table (DataFrame) – Record error table.

Returns:

Expected relative extra elements for each reference cluster.

Return type:

Series

Examples

>>> prediction = pd.Series(index=[1,2,3,4,5,6,7,8], data=[1,1,2,3,2,4,4,4])
>>> sample = pd.Series(index=[1,2,3,4,5,6,7], data=["c1", "c1", "c1", "c2", "c2", "c3", "c3"])
>>> error_table = record_error_table(prediction, sample)
>>> expected_relative_extra_from_table(error_table)
reference
c1    0.166667
c2    0.250000
c3    0.333333
Name: expected_relative_extra, dtype: float64

The result is the same as calling er_evaluation.error_analysis.expected_relative_extra() directly on prediction and sample:

>>> from er_evaluation.error_analysis import expected_relative_extra
>>> expected_relative_extra(prediction, sample)
reference
c1    0.166667
c2    0.250000
c3    0.333333
Name: expected_relative_extra, dtype: float64