Make the pairwise function more convenient

dustalov · Jul 9, 2024 · ab6eb81 · ab6eb81
1 parent 8c26b25
commit ab6eb81
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/Tutorial.ipynb b/Tutorial.ipynb
@@ -133,9 +133,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "bt_pairwise = evalica.pairwise(bt_result.scores)\n",
-    "\n",
-    "df_bt_pairwise = pd.DataFrame(bt_pairwise, index=bt_result.scores.index, columns=bt_result.scores.index)\n",
+    "df_bt_pairwise = evalica.pairwise_frame(bt_result.scores.sort_values(ascending=False))\n",
     "\n",
     "df_bt_pairwise"
    ]
@@ -149,8 +147,11 @@
    "source": [
     "def visualize(df_pairwise: pd.DataFrame) -> Figure:\n",
     "    fig = px.imshow(df_pairwise, color_continuous_scale=\"RdBu\", text_auto=\".2f\")\n",
+    "\n",
     "    fig.update_layout(xaxis_title=\"Loser\", yaxis_title=\"Winner\", xaxis_side=\"top\")\n",
+    "\n",
     "    fig.update_traces(hovertemplate=\"Winner: %{y}<br>Loser: %{x}<br>Fraction of Wins: %{z}<extra></extra>\")\n",
+    "\n",
     "    return fig"
    ]
   },

diff --git a/python/evalica/__init__.py b/python/evalica/__init__.py
@@ -319,13 +319,12 @@ def pagerank(
     )
 
 
-def _pairwise_ndarray(scores: npt.NDArray[np.float64]) -> npt.NDArray[np.float64]:
+def pairwise_scores(scores: npt.NDArray[np.float64]) -> npt.NDArray[np.float64]:
     return scores[:, np.newaxis] / (scores + scores[:, np.newaxis])
 
 
-def pairwise(scores: pd.Series[T]) -> npt.NDArray[np.float64]:  # type: ignore[type-var]
-    scores = scores.sort_values(ascending=False)
-    return _pairwise_ndarray(scores.to_numpy())
+def pairwise_frame(scores: pd.Series[T]) -> pd.DataFrame:  # type: ignore[type-var]
+    return pd.DataFrame(pairwise_scores(scores.to_numpy()), index=scores.index, columns=scores.index)
 
 
 __all__ = [
@@ -340,5 +339,6 @@ def pairwise(scores: pd.Series[T]) -> npt.NDArray[np.float64]:  # type: ignore[t
     "matrices",
     "newman",
     "pagerank",
-    "pairwise",
+    "pairwise_scores",
+    "pairwise_frame",
 ]