/usr/lib/python3/dist-packages/networkx/algorithms/link_analysis/pagerank_alg.py is in python3-networkx 1.8.1-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | """PageRank analysis of graph structure. """
# Copyright (C) 2004-2011 by
# Aric Hagberg <hagberg@lanl.gov>
# Dan Schult <dschult@colgate.edu>
# Pieter Swart <swart@lanl.gov>
# All rights reserved.
# BSD license.
# NetworkX:http://networkx.lanl.gov/
import networkx as nx
from networkx.exception import NetworkXError
__author__ = """Aric Hagberg (hagberg@lanl.gov)"""
__all__ = ['pagerank','pagerank_numpy','pagerank_scipy','google_matrix']
def pagerank(G,alpha=0.85,personalization=None,
max_iter=100,tol=1.0e-8,nstart=None,weight='weight'):
"""Return the PageRank of the nodes in the graph.
PageRank computes a ranking of the nodes in the graph G based on
the structure of the incoming links. It was originally designed as
an algorithm to rank web pages.
Parameters
-----------
G : graph
A NetworkX graph
alpha : float, optional
Damping parameter for PageRank, default=0.85
personalization: dict, optional
The "personalization vector" consisting of a dictionary with a
key for every graph node and nonzero personalization value for each node.
max_iter : integer, optional
Maximum number of iterations in power method eigenvalue solver.
tol : float, optional
Error tolerance used to check convergence in power method solver.
nstart : dictionary, optional
Starting value of PageRank iteration for each node.
weight : key, optional
Edge data key to use as weight. If None weights are set to 1.
Returns
-------
pagerank : dictionary
Dictionary of nodes with PageRank as value
Examples
--------
>>> G=nx.DiGraph(nx.path_graph(4))
>>> pr=nx.pagerank(G,alpha=0.9)
Notes
-----
The eigenvector calculation is done by the power iteration method
and has no guarantee of convergence. The iteration will stop
after max_iter iterations or an error tolerance of
number_of_nodes(G)*tol has been reached.
The PageRank algorithm was designed for directed graphs but this
algorithm does not check if the input graph is directed and will
execute on undirected graphs by converting each oriented edge in the
directed graph to two edges.
See Also
--------
pagerank_numpy, pagerank_scipy, google_matrix
References
----------
.. [1] A. Langville and C. Meyer,
"A survey of eigenvector methods of web information retrieval."
http://citeseer.ist.psu.edu/713792.html
.. [2] Page, Lawrence; Brin, Sergey; Motwani, Rajeev and Winograd, Terry,
The PageRank citation ranking: Bringing order to the Web. 1999
http://dbpubs.stanford.edu:8090/pub/showDoc.Fulltext?lang=en&doc=1999-66&format=pdf
"""
if type(G) == nx.MultiGraph or type(G) == nx.MultiDiGraph:
raise Exception("pagerank() not defined for graphs with multiedges.")
if len(G) == 0:
return {}
if not G.is_directed():
D=G.to_directed()
else:
D=G
# create a copy in (right) stochastic form
W=nx.stochastic_graph(D, weight=weight)
scale=1.0/W.number_of_nodes()
# choose fixed starting vector if not given
if nstart is None:
x=dict.fromkeys(W,scale)
else:
x=nstart
# normalize starting vector to 1
s=1.0/sum(x.values())
for k in x: x[k]*=s
# assign uniform personalization/teleportation vector if not given
if personalization is None:
p=dict.fromkeys(W,scale)
else:
p=personalization
# normalize starting vector to 1
s=1.0/sum(p.values())
for k in p:
p[k]*=s
if set(p)!=set(G):
raise NetworkXError('Personalization vector '
'must have a value for every node')
# "dangling" nodes, no links out from them
out_degree=W.out_degree()
dangle=[n for n in W if out_degree[n]==0.0]
i=0
while True: # power iteration: make up to max_iter iterations
xlast=x
x=dict.fromkeys(xlast.keys(),0)
danglesum=alpha*scale*sum(xlast[n] for n in dangle)
for n in x:
# this matrix multiply looks odd because it is
# doing a left multiply x^T=xlast^T*W
for nbr in W[n]:
x[nbr]+=alpha*xlast[n]*W[n][nbr][weight]
x[n]+=danglesum+(1.0-alpha)*p[n]
# normalize vector
s=1.0/sum(x.values())
for n in x:
x[n]*=s
# check convergence, l1 norm
err=sum([abs(x[n]-xlast[n]) for n in x])
if err < tol:
break
if i>max_iter:
raise NetworkXError('pagerank: power iteration failed to converge '
'in %d iterations.'%(i-1))
i+=1
return x
def google_matrix(G, alpha=0.85, personalization=None,
nodelist=None, weight='weight'):
"""Return the Google matrix of the graph.
Parameters
-----------
G : graph
A NetworkX graph
alpha : float
The damping factor
personalization: dict, optional
The "personalization vector" consisting of a dictionary with a
key for every graph node and nonzero personalization value for each node.
nodelist : list, optional
The rows and columns are ordered according to the nodes in nodelist.
If nodelist is None, then the ordering is produced by G.nodes().
weight : key, optional
Edge data key to use as weight. If None weights are set to 1.
Returns
-------
A : NumPy matrix
Google matrix of the graph
See Also
--------
pagerank, pagerank_numpy, pagerank_scipy
"""
try:
import numpy as np
except ImportError:
raise ImportError(\
"google_matrix() requires NumPy: http://scipy.org/")
# choose ordering in matrix
if personalization is None: # use G.nodes() ordering
nodelist=G.nodes()
else: # use personalization "vector" ordering
nodelist=personalization.keys()
if set(nodelist)!=set(G):
raise NetworkXError('Personalization vector dictionary'
'must have a value for every node')
M=nx.to_numpy_matrix(G,nodelist=nodelist,weight=weight)
(n,m)=M.shape # should be square
if n == 0:
return M
# add constant to dangling nodes' row
dangling=np.where(M.sum(axis=1)==0)
for d in dangling[0]:
M[d]=1.0/n
# normalize
M=M/M.sum(axis=1)
# add "teleportation"/personalization
e=np.ones((n))
if personalization is not None:
v=np.array(list(personalization.values()),dtype=float)
else:
v=e
v=v/v.sum()
P=alpha*M+(1-alpha)*np.outer(e,v)
return P
def pagerank_numpy(G, alpha=0.85, personalization=None, weight='weight'):
"""Return the PageRank of the nodes in the graph.
PageRank computes a ranking of the nodes in the graph G based on
the structure of the incoming links. It was originally designed as
an algorithm to rank web pages.
Parameters
-----------
G : graph
A NetworkX graph
alpha : float, optional
Damping parameter for PageRank, default=0.85
personalization: dict, optional
The "personalization vector" consisting of a dictionary with a
key for every graph node and nonzero personalization value for each node.
weight : key, optional
Edge data key to use as weight. If None weights are set to 1.
Returns
-------
pagerank : dictionary
Dictionary of nodes with PageRank as value
Examples
--------
>>> G=nx.DiGraph(nx.path_graph(4))
>>> pr=nx.pagerank_numpy(G,alpha=0.9)
Notes
-----
The eigenvector calculation uses NumPy's interface to the LAPACK
eigenvalue solvers. This will be the fastest and most accurate
for small graphs.
This implementation works with Multi(Di)Graphs.
See Also
--------
pagerank, pagerank_scipy, google_matrix
References
----------
.. [1] A. Langville and C. Meyer,
"A survey of eigenvector methods of web information retrieval."
http://citeseer.ist.psu.edu/713792.html
.. [2] Page, Lawrence; Brin, Sergey; Motwani, Rajeev and Winograd, Terry,
The PageRank citation ranking: Bringing order to the Web. 1999
http://dbpubs.stanford.edu:8090/pub/showDoc.Fulltext?lang=en&doc=1999-66&format=pdf
"""
try:
import numpy as np
except ImportError:
raise ImportError("pagerank_numpy() requires NumPy: http://scipy.org/")
if len(G) == 0:
return {}
# choose ordering in matrix
if personalization is None: # use G.nodes() ordering
nodelist=G.nodes()
else: # use personalization "vector" ordering
nodelist=personalization.keys()
M=google_matrix(G, alpha, personalization=personalization,
nodelist=nodelist, weight=weight)
# use numpy LAPACK solver
eigenvalues,eigenvectors=np.linalg.eig(M.T)
ind=eigenvalues.argsort()
# eigenvector of largest eigenvalue at ind[-1], normalized
largest=np.array(eigenvectors[:,ind[-1]]).flatten().real
norm=float(largest.sum())
centrality=dict(zip(nodelist,map(float,largest/norm)))
return centrality
def pagerank_scipy(G, alpha=0.85, personalization=None,
max_iter=100, tol=1.0e-6, weight='weight'):
"""Return the PageRank of the nodes in the graph.
PageRank computes a ranking of the nodes in the graph G based on
the structure of the incoming links. It was originally designed as
an algorithm to rank web pages.
Parameters
-----------
G : graph
A NetworkX graph
alpha : float, optional
Damping parameter for PageRank, default=0.85
personalization: dict, optional
The "personalization vector" consisting of a dictionary with a
key for every graph node and nonzero personalization value for each node.
max_iter : integer, optional
Maximum number of iterations in power method eigenvalue solver.
tol : float, optional
Error tolerance used to check convergence in power method solver.
weight : key, optional
Edge data key to use as weight. If None weights are set to 1.
Returns
-------
pagerank : dictionary
Dictionary of nodes with PageRank as value
Examples
--------
>>> G=nx.DiGraph(nx.path_graph(4))
>>> pr=nx.pagerank_scipy(G,alpha=0.9)
Notes
-----
The eigenvector calculation uses power iteration with a SciPy
sparse matrix representation.
See Also
--------
pagerank, pagerank_numpy, google_matrix
References
----------
.. [1] A. Langville and C. Meyer,
"A survey of eigenvector methods of web information retrieval."
http://citeseer.ist.psu.edu/713792.html
.. [2] Page, Lawrence; Brin, Sergey; Motwani, Rajeev and Winograd, Terry,
The PageRank citation ranking: Bringing order to the Web. 1999
http://dbpubs.stanford.edu:8090/pub/showDoc.Fulltext?lang=en&doc=1999-66&format=pdf
"""
try:
import scipy.sparse
except ImportError:
raise ImportError("pagerank_scipy() requires SciPy: http://scipy.org/")
if len(G) == 0:
return {}
# choose ordering in matrix
if personalization is None: # use G.nodes() ordering
nodelist=G.nodes()
else: # use personalization "vector" ordering
nodelist=personalization.keys()
M=nx.to_scipy_sparse_matrix(G,nodelist=nodelist,weight=weight,dtype='f')
(n,m)=M.shape # should be square
S=scipy.array(M.sum(axis=1)).flatten()
# for i, j, v in zip( *scipy.sparse.find(M) ):
# M[i,j] = v / S[i]
S[S>0] = 1.0 / S[S>0]
Q = scipy.sparse.spdiags(S.T, 0, *M.shape, format='csr')
M = Q * M
x=scipy.ones((n))/n # initial guess
dangle=scipy.array(scipy.where(M.sum(axis=1)==0,1.0/n,0)).flatten()
# add "teleportation"/personalization
if personalization is not None:
v=scipy.array(list(personalization.values()),dtype=float)
v=v/v.sum()
else:
v=x
i=0
while i <= max_iter:
# power iteration: make up to max_iter iterations
xlast=x
x=alpha*(x*M+scipy.dot(dangle,xlast))+(1-alpha)*v
x=x/x.sum()
# check convergence, l1 norm
err=scipy.absolute(x-xlast).sum()
if err < n*tol:
return dict(zip(nodelist,map(float,x)))
i+=1
raise NetworkXError('pagerank_scipy: power iteration failed to converge'
'in %d iterations.'%(i+1))
# fixture for nose tests
def setup_module(module):
from nose import SkipTest
try:
import numpy
except:
raise SkipTest("NumPy not available")
try:
import scipy
except:
raise SkipTest("SciPy not available")
|