scikit-network 0.32.1__cp311-cp311-win_amd64.whl → 0.33.0__cp311-cp311-win_amd64.whl

sknetwork/data/toy_graphs.py

@@ -11,10 +11,10 @@ from typing import Union
 import numpy as np
 from scipy import sparse
 
-from sknetwork.data.base import Bunch
+from sknetwork.data.base import Dataset
 
 
-def house(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def house(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """House graph.
 
     * Undirected graph
@@ -46,7 +46,7 @@ def house(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
     if metadata:
         x = np.array([0, -1, -1, 1, 1])
         y = np.array([2, 1, -1, -1, 1])
-        graph = Bunch()
+        graph = Dataset()
         graph.adjacency = adjacency
         graph.position = np.vstack((x, y)).T
         graph.name = 'house'
@@ -55,7 +55,7 @@ def house(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         return adjacency
 
 
-def bow_tie(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def bow_tie(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Bow tie graph.
 
     * Undirected graph
@@ -86,7 +86,7 @@ def bow_tie(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
     if metadata:
         x = np.array([0, -1, 1, -1, 1])
         y = np.array([0, 1, 1, -1, -1])
-        graph = Bunch()
+        graph = Dataset()
         graph.adjacency = adjacency
         graph.position = np.vstack((x, y)).T
         graph.name = 'bow_tie'
@@ -95,7 +95,7 @@ def bow_tie(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         return adjacency
 
 
-def karate_club(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def karate_club(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Karate club graph.
 
     * Undirected graph
@@ -150,7 +150,7 @@ def karate_club(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
             [-0.33, -0.15, -0.01, -0.28, -0.64, -0.75, -0.76, -0.25,  0.09, 0.23, -0.62, -0.4, -0.53, -0.07,
              0.55,  0.64, -1., -0.42, 0.6, -0.01,  0.45, -0.34,  0.61,  0.41,  0.14,  0.28,  0.68, 0.21,
              0.12,  0.54,  0.19,  0.09,  0.38,  0.33])
-        graph = Bunch()
+        graph = Dataset()
         graph.adjacency = adjacency
         graph.labels = labels
         graph.position = np.vstack((x, y)).T
@@ -160,7 +160,7 @@ def karate_club(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         return adjacency
 
 
-def miserables(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def miserables(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Co-occurrence graph of the characters in the novel Les miserables by Victor Hugo.
 
     * Undirected graph
@@ -257,7 +257,7 @@ def miserables(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
              0.05, 0.12,  0.82,  0.44,  0.06, -0.2, -0.4, -0.28, -0.68, -0.79, -0.4, -0.07, -0.51, -0.17, -0.03,
              -0.09, -0.14, -0.04, -0.04, -0.07, -0.06, -0.11, -0.06, -0.35,  0.24,  0.19,  0.22,  0.29, -0.2,
              0.06,  0.14,  0.3, -0.1])
-        graph = Bunch()
+        graph = Dataset()
         graph.adjacency = adjacency
         graph.names = np.array(names)
         graph.position = np.vstack((x, y)).T
@@ -267,7 +267,7 @@ def miserables(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         return adjacency
 
 
-def painters(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def painters(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Graph of links between some famous painters on Wikipedia.
 
     * Directed graph
@@ -312,7 +312,7 @@ def painters(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         y = np.array(
             [0.53, 0.19, -0.71, 0.44, -0.48, -0.65, 0.69, -0.11, 0.01,
              -1., 0.49, 0.28, 0.06, 0.27])
-        graph = Bunch()
+        graph = Dataset()
         graph.adjacency = adjacency
         graph.names = names
         graph.position = np.stack((x, y)).T
@@ -322,7 +322,7 @@ def painters(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         return adjacency
 
 
-def hourglass(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def hourglass(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Hourglass graph.
 
     * Bipartite graph
@@ -342,14 +342,14 @@ def hourglass(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
     """
     biadjacency = sparse.csr_matrix(np.ones((2, 2), dtype=bool))
     if metadata:
-        graph = Bunch()
+        graph = Dataset()
         graph.biadjacency = biadjacency
         return graph
     else:
         return biadjacency
 
 
-def star_wars(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def star_wars(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Bipartite graph connecting some Star Wars villains to the movies in which they appear.
 
     * Bipartite graph
@@ -380,7 +380,7 @@ def star_wars(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
     if metadata:
         villains = np.array(['Jabba', 'Greedo', 'Vader', 'Boba'])
         movies = np.array(['A New Hope', 'The Empire Strikes Back', 'Return Of The Jedi'])
-        graph = Bunch()
+        graph = Dataset()
         graph.biadjacency = biadjacency
         graph.names = villains
         graph.names_row = villains
@@ -391,14 +391,12 @@ def star_wars(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
         return biadjacency
 
 
-def movie_actor(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def movie_actor(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Bipartite graph connecting movies to some actors starring in them.
 
     * Bipartite graph
-    * 31 nodes (15 movies, 16 actors), 42 edges
-    * 9 labels (rows)
+    * 32 nodes (15 movies, 17 actors), 43 edges
     * Names of movies (rows) and actors (columns)
-    * Names of movies production company (rows)
 
     Parameters
     ----------
@@ -407,53 +405,47 @@ def movie_actor(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
 
     Returns
     -------
-    biadjacency or graph : Union[sparse.csr_matrix, Dataset]
-        Biadjacency matrix or graph with metadata (names).
+    biadjacency or dataset : Union[sparse.csr_matrix, Dataset]
+        Biadjacency matrix or dataset with metadata (names of movies and actors).
 
     Example
     -------
     >>> from sknetwork.data import movie_actor
     >>> biadjacency = movie_actor()
     >>> biadjacency.shape
-    (15, 16)
+    (15, 17)
     """
     row = np.array(
         [0, 0, 0, 1, 1, 1, 2, 2, 2, 2, 3, 3, 4, 4, 5, 5, 6,
-         6, 6, 7, 7, 8, 8, 8, 8, 8, 9, 9, 9, 10, 10, 10, 11, 11, 11,
+         6, 6, 7, 7, 8, 8, 8, 8, 8, 9, 9, 9, 10, 10, 10, 10, 11, 11, 11,
          12, 12, 12, 13, 13, 14, 14])
     col = np.array(
         [0, 1, 2, 1, 2, 3, 3, 4, 5, 8, 4, 6, 0, 6, 4, 7, 4,
-         7, 8, 3, 8, 9, 10, 11, 12, 15, 0, 11, 12, 9, 10, 13, 5, 9, 13,
-         1, 9, 15, 12, 14, 11, 14])
-    biadjacency = sparse.csr_matrix((np.ones(len(row), dtype=bool), (row, col)), shape=(15, 16))
+         7, 8, 3, 8, 9, 10, 11, 12, 15, 0, 11, 12, 9, 10, 13, 16, 5, 9, 13,
+         1, 9, 15, 12, 14, 14, 16])
+    biadjacency = sparse.csr_matrix((np.ones(len(row), dtype=bool), (row, col)), shape=(15, 17))
 
     if metadata:
         movies = np.array(
             ['Inception', 'The Dark Knight Rises', 'The Big Short', 'Drive', 'The Great Gatsby', 'La La Land',
              'Crazy Stupid Love', 'Vice', 'The Grand Budapest Hotel', 'Aviator', '007 Spectre', 'Inglourious Basterds',
-             'Midnight In Paris', 'Murder on the Orient Express', 'Fantastic Beasts 2'])
+             'Midnight In Paris', 'Murder on the Orient Express', "Pirates of the Caribbean: At World's End"])
         actors = np.array(
             ['Leonardo DiCaprio', 'Marion Cotillard', 'Joseph Gordon Lewitt', 'Christian Bale', 'Ryan Gosling',
              'Brad Pitt', 'Carey Mulligan', 'Emma Stone', 'Steve Carell', 'Lea Seydoux', 'Ralph Fiennes', 'Jude Law',
-             'Willem Dafoe', 'Christophe Waltz', 'Johnny Depp', 'Owen Wilson'])
-        graph = Bunch()
-        graph.biadjacency = biadjacency
-        graph.names = movies
-        graph.names_row = movies
-        graph.names_col = actors
-        graph.labels = np.array([0, 0, 1, 2, 3, 2, 4, 1, 5, 0, 6, 5, 7, 8, 0])
-        graph.labels_name = np.array(['Warner Bros', 'Plan B Entertainment', 'Marc Platt Productions', 'Bazmark Films',
-                                      'Carousel Productions', 'Babelsberg Studios', 'MGM', 'Gravier Productions',
-                                      'Genre Films'])
-        graph.labels_row = graph.labels
-        graph.labels_row_name = graph.labels_name
-        graph.name = 'movie_actor'
-        return graph
+             'Willem Dafoe', 'Christophe Waltz', 'Johnny Depp', 'Owen Wilson', 'Naomie Harris'])
+        dataset = Dataset()
+        dataset.biadjacency = biadjacency
+        dataset.names = movies
+        dataset.names_row = movies
+        dataset.names_col = actors
+        dataset.name = 'movie_actor'
+        return dataset
     else:
         return biadjacency
 
 
-def art_philo_science(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]:
+def art_philo_science(metadata: bool = False) -> Union[sparse.csr_matrix, Dataset]:
     """Wikipedia links between 30 articles (10 artists, 10 philosophers, 10 scientists).
 
     * Directed graph
@@ -605,7 +597,7 @@ def art_philo_science(metadata: bool = False) -> Union[sparse.csr_matrix, Bunch]
         words = np.array(
             ['contribution', 'theory', 'invention', 'time', 'modern',
              'century', 'study', 'logic', 'school', 'author', 'compose'])
-        graph = Bunch()
+        graph = Dataset()
         graph.adjacency = adjacency
         graph.names = names
         graph.position = position

sknetwork/embedding/base.py

@@ -82,6 +82,9 @@ class BaseEmbedding(Algorithm, ABC):
         self.embedding_row_ = None
         self.embedding_col_ = None
 
+    def _check_fitted(self):
+        return self.embedding_ is not None
+
     def _split_vars(self, shape):
         """Split labels_ into labels_row_ and labels_col_"""
         n_row = shape[0]

sknetwork/embedding/louvain_embedding.py

@@ -146,29 +146,3 @@ class LouvainEmbedding(BaseEmbedding):
             self.embedding_col_ = embedding_col.toarray()
 
         return self
-
-    def predict(self, adjacency_vectors: Union[sparse.csr_matrix, np.ndarray]) -> np.ndarray:
-        """Predict the embedding of new rows, defined by their adjacency vectors.
-
-        Parameters
-        ----------
-        adjacency_vectors :
-            Adjacency row vectors.
-            Array of shape (n_col,) (single vector) or (n_vectors, n_col)
-
-        Returns
-        -------
-        embedding_vectors : np.ndarray
-            Embedding of the nodes.
-        """
-        self._check_fitted()
-        if self.embedding_col_ is not None:
-            n = len(self.embedding_col_)
-        else:
-            n = len(self.embedding_)
-
-        adjacency_vectors = check_adjacency_vector(adjacency_vectors, n)
-        check_nonnegative(adjacency_vectors)
-        membership = get_membership(self.labels_)
-
-        return normalize(adjacency_vectors).dot(membership)

sknetwork/embedding/svd.py

@@ -277,10 +277,6 @@ class SVD(GSVD):
                                   factor_singular=factor_singular, factor_row=0., factor_col=0., normalized=normalized,
                                   solver=solver)
 
-    @staticmethod
-    def _check_adj_vector(adjacency_vectors: np.ndarray):
-        return
-
 
 class PCA(SVD):
     """Graph embedding by Principal Component Analysis of the adjacency or biadjacency matrix.

sknetwork/embedding/tests/test_louvain_embedding.py

@@ -13,16 +13,21 @@ class TestLouvainEmbedding(unittest.TestCase):
 
     def test_predict(self):
         adjacency = test_graph()
+        adjacency_vector = np.zeros(10, dtype=int)
+        adjacency_vector[:5] = 1
         louvain = LouvainEmbedding()
-        louvain.fit(test_graph())
+        louvain.fit(adjacency)
         self.assertEqual(louvain.embedding_.shape[0], 10)
         louvain.fit(adjacency, force_bipartite=True)
         self.assertEqual(louvain.embedding_.shape[0], 10)
 
+        # bipartite
+        biadjacency = test_bigraph()
+        louvain.fit(biadjacency)
+        self.assertEqual(louvain.embedding_row_.shape[0], 6)
+        self.assertEqual(louvain.embedding_col_.shape[0], 8)
+
         for method in ['remove', 'merge', 'keep']:
             louvain = LouvainEmbedding(isolated_nodes=method)
             embedding = louvain.fit_transform(adjacency)
             self.assertEqual(embedding.shape[0], adjacency.shape[0])
-
-
-

sknetwork/embedding/tests/test_svd.py

@@ -24,6 +24,9 @@ class TestSVD(unittest.TestCase):
         self.assertEqual(gsvd.embedding_row_.shape, (n_row, min_dim))
         self.assertEqual(gsvd.embedding_col_.shape, (n_col, min_dim))
 
+        embedding = gsvd.predict(np.array([0, 1, 1]))
+        self.assertEqual(embedding.shape, (min_dim,))
+
         gsvd = GSVD(n_components=1, regularization=0.1, solver='lanczos')
         gsvd.fit(biadjacency)
         self.assertEqual(gsvd.embedding_row_.shape, (n_row, 1))
@@ -31,6 +34,9 @@ class TestSVD(unittest.TestCase):
         pca = PCA(n_components=min_dim, solver='lanczos')
         pca.fit(biadjacency)
         self.assertEqual(pca.embedding_row_.shape, (n_row, min_dim))
+        pca = PCA(n_components=min_dim, solver=LanczosSVD())
+        pca.fit(biadjacency)
+        self.assertEqual(pca.embedding_row_.shape, (n_row, min_dim))
 
         svd = SVD(n_components=min_dim, solver=LanczosSVD())
         svd.fit(biadjacency)

sknetwork/gnn/gnn_classifier.py

@@ -93,7 +93,7 @@ class GNNClassifier(BaseGNN):
     >>> features = adjacency.copy()
     >>> gnn = GNNClassifier(dims=1, early_stopping=False)
     >>> labels_pred = gnn.fit_predict(adjacency, features, labels, random_state=42)
-    >>> np.round(np.mean(labels_pred == labels_true), 2)
+    >>> round(np.mean(labels_pred == labels_true), 2)
     0.88
     """
 

sknetwork/hierarchy/louvain_hierarchy.py

@@ -128,21 +128,23 @@ class LouvainIteration(BaseHierarchy):
                 tree.append(self._recursive_louvain(adjacency_cluster, depth - 1, nodes_cluster))
             return tree
 
-    def fit(self, input_matrix: Union[sparse.csr_matrix, np.ndarray]) -> 'LouvainIteration':
+    def fit(self, input_matrix: Union[sparse.csr_matrix, np.ndarray], force_bipartite: bool = False) \
+            -> 'LouvainIteration':
         """Fit algorithm to data.
 
         Parameters
         ----------
         input_matrix : sparse.csr_matrix, np.ndarray
             Adjacency matrix or biadjacency matrix of the graph.
+        force_bipartite :
+            If ``True``, force the input matrix to be considered as a biadjacency matrix.
 
         Returns
         -------
         self: :class:`LouvainIteration`
         """
         self._init_vars()
-        input_matrix = check_format(input_matrix)
-        adjacency, self.bipartite = get_adjacency(input_matrix)
+        adjacency, self.bipartite = get_adjacency(input_matrix, force_bipartite=force_bipartite)
         tree = self._recursive_louvain(adjacency, self.depth)
         dendrogram, _ = get_dendrogram(tree)
         dendrogram = np.array(dendrogram)
@@ -243,21 +245,23 @@ class LouvainHierarchy(BaseHierarchy):
                 labels_unique = np.unique(labels)
         return tree
 
-    def fit(self, input_matrix: Union[sparse.csr_matrix, np.ndarray]) -> 'LouvainHierarchy':
+    def fit(self, input_matrix: Union[sparse.csr_matrix, np.ndarray], force_bipartite: bool = False) \
+            -> 'LouvainHierarchy':
         """Fit algorithm to data.
 
         Parameters
         ----------
         input_matrix : sparse.csr_matrix, np.ndarray
             Adjacency matrix or biadjacency matrix of the graph.
+        force_bipartite :
+            If ``True``, force the input matrix to be considered as a biadjacency matrix.
 
         Returns
         -------
         self: :class:`LouvainHierarchy`
         """
         self._init_vars()
-        input_matrix = check_format(input_matrix)
-        adjacency, self.bipartite = get_adjacency(input_matrix)
+        adjacency, self.bipartite = get_adjacency(input_matrix, force_bipartite=force_bipartite)
         tree = self._get_hierarchy(adjacency)
         dendrogram, _ = get_dendrogram(tree)
         dendrogram = np.array(dendrogram)