decoupler.bm.metric.hmean

Contents

decoupler.bm.metric.hmean#

decoupler.bm.metric.hmean(df, metrics=None, beta=0.5)#

Computes the harmonic mean between two metric statistics.

Parameters:

  • df (DataFrame) – Result of decoupler.bm.benchmark.

  • metrics (str | list | None (default: None)) – Metrics which to compute the harmonic mean between their own statistics.

  • beta (int | float (default: 0.5)) – Controls the balance between statistics, where beta > 1 favors the first one (for example recall), beta < 1 the other one (for example precision), and beta = 1 gives equal weight to both.

Return type:

DataFrame

Returns:

Dataframe containing the harmonic mean per metric.

Contents