File: test_Optimiser.py

package info (click to toggle)
python-leidenalg 0.10.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,020 kB
  • sloc: cpp: 1,727; python: 1,268; ansic: 237; sh: 97; makefile: 7
file content (171 lines) | stat: -rw-r--r-- 8,206 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
import unittest
import igraph as ig
import leidenalg

from functools import reduce

class OptimiserTest(unittest.TestCase):

  def setUp(self):
    self.optimiser = leidenalg.Optimiser()

  def test_move_nodes(self):
    G = ig.Graph.Full(100)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0.5)
    self.optimiser.move_nodes(partition, consider_comms=leidenalg.ALL_NEIGH_COMMS)
    self.assertListEqual(
        partition.sizes(), [100],
        msg="CPMVertexPartition(resolution_parameter=0.5) of complete graph after move nodes incorrect.")

  def test_move_nodes_with_max_comm_size(self):
    G = ig.Graph.Full(100)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0.5)
    self.optimiser.max_comm_size = 17
    self.optimiser.move_nodes(partition, consider_comms=leidenalg.ALL_NEIGH_COMMS)
    self.assertListEqual(
        partition.sizes(), [17, 17, 17, 17, 17, 15],
        msg="CPMVertexPartition(resolution_parameter=0.5) of complete graph after move nodes (max_comm_size=17) incorrect.")

  def test_move_nodes_with_fixed(self):
    # One edge plus singleton, but the two connected nodes are fixed
    G = ig.Graph([(0, 2)])
    is_membership_fixed = [True, False, True]
    partition = leidenalg.CPMVertexPartition(
            G,
            resolution_parameter=0.1)
    self.optimiser.move_nodes(partition, is_membership_fixed=is_membership_fixed, consider_comms=leidenalg.ALL_NEIGH_COMMS)
    self.assertListEqual(
        partition.sizes(), [1, 1, 1],
        msg="CPMVertexPartition(resolution_parameter=0.1) of one edge plus singleton after move nodes with fixed nodes is incorrect.")

  def test_merge_nodes(self):
    G = ig.Graph.Full(100)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0.5)
    self.optimiser.merge_nodes(partition, consider_comms=leidenalg.ALL_NEIGH_COMMS)
    self.assertListEqual(
        partition.sizes(), [100],
        msg="CPMVertexPartition(resolution_parameter=0.5) of complete graph after merge nodes incorrect.")
    self.assertEqual(
        partition.total_weight_in_all_comms(),
        G.ecount(),
        msg="total_weight_in_all_comms not equal to ecount of graph.")

  def test_merge_nodes_with_max_comm_size(self):
    G = ig.Graph.Full(100)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0.5)
    self.optimiser.max_comm_size = 17
    self.optimiser.merge_nodes(partition, consider_comms=leidenalg.ALL_NEIGH_COMMS)
    self.assertListEqual(
        partition.sizes(), [17, 17, 17, 17, 17, 15],
        msg="CPMVertexPartition(resolution_parameter=0.5) of complete graph after merge nodes (max_comm_size=17) incorrect.")

  def test_diff_move_node_optimality(self):
    G = ig.Graph.Erdos_Renyi(100, p=5./100, directed=False, loops=False)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0.1)
    while 0 < self.optimiser.move_nodes(partition, consider_comms=leidenalg.ALL_NEIGH_COMMS):
      pass
    for v in G.vs:
      neigh_comms = set(partition.membership[u.index] for u in v.neighbors())
      for c in neigh_comms:
        self.assertLessEqual(
          partition.diff_move(v.index, c), 1e-10, # Allow for a small difference up to rounding error.
          msg="Was able to move a node to a better community, violating node optimality.")

  def test_optimiser(self):
    G = reduce(ig.Graph.disjoint_union, (ig.Graph.Tree(10, 3, mode=ig.TREE_UNDIRECTED) for i in range(10)))
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0)
    self.optimiser.consider_comms=leidenalg.ALL_NEIGH_COMMS
    self.optimiser.optimise_partition(partition)
    self.assertListEqual(
        partition.sizes(), 10*[10],
        msg="After optimising partition failed to find different components with CPMVertexPartition(resolution_parameter=0)")

  def test_optimiser_with_max_comm_size(self):
    G = ig.Graph.Full(100)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0)
    self.optimiser.consider_comms=leidenalg.ALL_NEIGH_COMMS
    self.optimiser.max_comm_size = 10
    self.optimiser.optimise_partition(partition)
    self.assertListEqual(
        partition.sizes(), 10*[10],
        msg="After optimising partition (max_comm_size=10) failed to find different components with CPMVertexPartition(resolution_parameter=0)")

  def test_optimiser_split_with_max_comm_size(self):
    G = ig.Graph.Full(100)
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=0.5)
    self.optimiser.merge_nodes(partition, consider_comms=leidenalg.ALL_NEIGH_COMMS)
    self.assertListEqual(
        partition.sizes(), [100],
        msg="CPMVertexPartition(resolution_parameter=0.5) of complete graph after merge nodes incorrect.")
    self.optimiser.max_comm_size = 10
    self.optimiser.optimise_partition(partition)
    self.assertListEqual(
        partition.sizes(), 10*[10],
        msg="After optimising partition (max_comm_size=10) failed to find different components with CPMVertexPartition(resolution_parameter=0.5)")

  def test_optimiser_with_is_membership_fixed(self):
      G = ig.Graph.Full(3)
      partition = leidenalg.CPMVertexPartition(
              G,
              resolution_parameter=0.01,
              initial_membership=[2, 1, 0])
      # Equivalent to setting initial membership
      #partition.set_membership([2, 1, 2])
      is_membership_fixed = [True, False, False]
      original_quality = partition.quality()
      diff = self.optimiser.optimise_partition(partition, is_membership_fixed=is_membership_fixed)
      self.assertAlmostEqual(partition.quality() - original_quality, diff, places=10,
                             msg="Optimisation with fixed nodes returns inconsistent quality")
      self.assertListEqual(
            partition.membership, [2, 2, 2],
            msg="After optimising partition with fixed nodes failed to recover initial fixed memberships"
            )

  def test_optimiser_is_membership_fixed_large_labels(self):
    G = ig.Graph.Erdos_Renyi(n=100, p=5./100, directed=True, loops=True)

    membership = list(range(G.vcount()))
    partition = leidenalg.RBConfigurationVertexPartition(G, initial_membership=membership)

    # large enough to force nonconsecutive labels in the final partition
    fixed_node_idx = 90
    is_membership_fixed = [False] * G.vcount()
    is_membership_fixed[fixed_node_idx] = True

    original_quality = partition.quality()
    diff = self.optimiser.optimise_partition(partition, is_membership_fixed=is_membership_fixed)

    self.assertLess(len(set(partition.membership)), len(partition),
                    msg="Optimisation with fixed nodes yielded too many communities")
    self.assertAlmostEqual(partition.quality() - original_quality, diff, places=10,
                           msg="Optimisation with fixed nodes returned inconsistent quality")
    self.assertEqual(partition.membership[fixed_node_idx], fixed_node_idx,
                     msg="Optimisation with fixed nodes failed to keep the associated community labels fixed")


  def test_neg_weight_bipartite(self):
    G = ig.Graph.Full_Bipartite(50, 50)
    G.es['weight'] = -0.1
    partition = leidenalg.CPMVertexPartition(G, resolution_parameter=-0.1, weights='weight')
    self.optimiser.consider_comms=leidenalg.ALL_COMMS
    self.optimiser.optimise_partition(partition)
    self.assertListEqual(
        partition.sizes(), 2*[50],
        msg="After optimising partition failed to find bipartite structure with CPMVertexPartition(resolution_parameter=-0.1)")

  def test_resolution_profile(self):
    G = ig.Graph.Famous('Zachary')
    profile = self.optimiser.resolution_profile(G, leidenalg.CPMVertexPartition, resolution_range=(0,1))
    self.assertListEqual(
      profile[0].sizes(), [G.vcount()],
      msg="Resolution profile incorrect: at resolution 0, not equal to a single community for CPM.")
    self.assertListEqual(
      profile[-1].sizes(), [1]*G.vcount(),
      msg="Resolution profile incorrect: at resolution 1, not equal to a singleton partition for CPM.")

#%%
if __name__ == '__main__':
  #%%
  unittest.main(verbosity=3)
  suite = unittest.TestLoader().discover('.')
  unittest.TextTestRunner(verbosity=1).run(suite)