scikit-network 0.33.3__cp313-cp313-macosx_10_13_x86_64.whl

sknetwork/ranking/base.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Created in November 2019
+@author: Nathan de Lara <nathan.delara@polytechnique.org>
+"""
+from abc import ABC
+
+import numpy as np
+
+from sknetwork.base import Algorithm
+
+
+class BaseRanking(Algorithm, ABC):
+    """Base class for ranking algorithms.
+
+    Attributes
+    ----------
+    scores_ : np.ndarray
+        Score of each node.
+    scores_row_: np.ndarray
+        Scores of rows, for bipartite graphs.
+    scores_col_: np.ndarray
+        Scores of columns, for bipartite graphs.
+    """
+    def __init__(self):
+        self.scores_ = None
+
+    def predict(self, columns: bool = False) -> np.ndarray:
+        """Return the scores predicted by the algorithm.
+
+        Parameters
+        ----------
+        columns : bool
+            If ``True``, return the prediction for columns.
+
+        Returns
+        -------
+        scores : np.ndarray
+            Scores.
+        """
+        if columns:
+            return self.scores_col_
+        return self.scores_
+
+    def fit_predict(self, *args, **kwargs) -> np.ndarray:
+        """Fit algorithm to data and return the scores. Same parameters as the ``fit`` method.
+
+        Returns
+        -------
+        scores : np.ndarray
+            Scores.
+        """
+        self.fit(*args, **kwargs)
+        return self.scores_
+
+    def _split_vars(self, shape):
+        n_row = shape[0]
+        self.scores_row_ = self.scores_[:n_row]
+        self.scores_col_ = self.scores_[n_row:]
+        self.scores_ = self.scores_row_