Counting

evalica.counting(xs, ys, winners, index=None, weights=None, win_weight=1.0, tie_weight=0.5, solver='pyo3', **kwargs)[source]

Count individual elements.

Parameters:
  • xs (Collection[T_contra]) – The left-hand side elements.

  • ys (Collection[T_contra]) – The right-hand side elements.

  • winners (Collection[Winner]) – The winner elements.

  • index (Index | None) – The index.

  • weights (Collection[float] | None) – The example weights.

  • win_weight (float) – The win weight.

  • tie_weight (float) – The tie weight.

  • solver (Literal['naive', 'pyo3']) – The solver.

  • **kwargs (Any) – The additional arguments.

Returns:

The counting result.

Return type:

CountingResult

class evalica.CountingResult(scores, index, win_weight, tie_weight, solver)[source]

The counting result.

Parameters:
scores

The element scores.

Type:

pandas.Series

index

The index.

Type:

pandas.Index

win_weight

The win weight.

Type:

float

tie_weight

The tie weight.

Type:

float

solver

The solver.

Type:

Literal[‘naive’, ‘pyo3’]

evalica.average_win_rate(xs, ys, winners, index=None, weights=None, win_weight=1.0, tie_weight=0.5, solver='pyo3', **kwargs)[source]

Count pairwise win rates between the elements and average per element.

Parameters:
  • xs (Collection[T_contra]) – The left-hand side elements.

  • ys (Collection[T_contra]) – The right-hand side elements.

  • winners (Collection[Winner]) – The winner elements.

  • index (Index | None) – The index.

  • weights (Collection[float] | None) – The example weights.

  • win_weight (float) – The win weight.

  • tie_weight (float) – The tie weight.

  • solver (Literal['naive', 'pyo3']) – The solver.

  • **kwargs (Any) – The additional arguments.

Returns:

The average win rate result.

Return type:

AverageWinRateResult

class evalica.AverageWinRateResult(scores, index, win_weight, tie_weight, solver)[source]

The average win rate result.

Parameters:
scores

The element scores.

Type:

pandas.Series

index

The index.

Type:

pandas.Index

win_weight

The win weight.

Type:

float

tie_weight

The tie weight.

Type:

float

solver

The solver.

Type:

Literal[‘naive’, ‘pyo3’]