File size: 19,547 Bytes
4c67792
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
c0c4834
4c67792
c0c4834
4c67792
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
c0c4834
 
 
 
 
 
4c67792
c0c4834
4c67792
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
"""
Bridge between igraph (the original graph format) and QAFD-RAG's flow diffusion.

Provides:
    - ``igraph_to_networkx``: convert an igraph.Graph to NetworkX (kept for
      compatibility, but no longer used in the main retrieval path).
    - ``IGraphQAFD``: igraph-native QAFD that matches the original
      ``QueryAwareFlowDiffusion`` exactly β€” numpy arrays, C-based neighbor
      lookups, no NetworkX conversion overhead.
"""

import logging
import random
from typing import Dict, List, Optional, Tuple

import numpy as np

logger = logging.getLogger(__name__)


# ===========================================================================
# igraph  -->  NetworkX  (kept for compatibility; not used in hot path)
# ===========================================================================

def igraph_to_networkx(ig_graph):
    """Convert an igraph.Graph to a NetworkX (undirected) graph."""
    import networkx as nx

    G = nx.Graph()
    name_attr = ig_graph.vs.attribute_names()
    has_name = "name" in name_attr

    for v in ig_graph.vs:
        node_id = v["name"] if has_name else v.index
        G.add_node(node_id)

    has_weight = "weight" in ig_graph.es.attribute_names()

    for e in ig_graph.es:
        src = ig_graph.vs[e.source]["name"] if has_name else e.source
        tgt = ig_graph.vs[e.target]["name"] if has_name else e.target
        w = e["weight"] if has_weight else 1.0
        G.add_edge(src, tgt, weight=w)

    return G


# ===========================================================================
# igraph-native Query-Aware Flow Diffusion
# ===========================================================================

def _cosine_similarity(vec1: np.ndarray, vec2: np.ndarray, mode: str = "normalized") -> float:
    """Cosine similarity with configurable contrast.

    Modes:
        "normalized": (cos+1)/2 β†’ [0, 1] (original, low contrast)
        "relu":       max(0, cos) β†’ [0, 1] (natural contrast)
        "relu_sq":    max(0, cos)Β² β†’ [0, 1] (sharpest contrast)
    """
    if len(vec1) == 0 or len(vec2) == 0:
        return 0.0
    dot = np.dot(vec1, vec2)
    m1 = np.linalg.norm(vec1)
    m2 = np.linalg.norm(vec2)
    if m1 == 0 or m2 == 0:
        return 0.0
    raw = dot / (m1 * m2)
    if mode == "relu":
        return max(0.0, raw)
    elif mode == "relu_sq":
        r = max(0.0, raw)
        return r * r
    else:  # "normalized" β€” original
        return max(0.0, (raw + 1.0) / 2.0)


class IGraphQAFD:
    """Query-Aware Flow Diffusion directly on igraph β€” matches the original exactly.

    Uses numpy arrays for mass/x/sink_capacity and igraph's C-based
    ``graph.neighbors()`` for fast neighbour lookups.

    Parameters
    ----------
    graph : igraph.Graph
    node_name_to_idx : dict
        Mapping from node name (str) -> vertex index (int).
    source_weights : np.ndarray
        Per-node seed weights (length = number of nodes). Will be normalised.
    node_embeddings : dict
        Mapping node_name -> np.ndarray embedding.
    query_embedding : np.ndarray
        Query embedding vector.
    alpha, epsilon, max_iterations, step_size : float / int
        Algorithm parameters.
    weight_scheme : str
        "original", "multiply", or "add".
    random_seed : int
    """

    def __init__(
        self,
        graph,
        node_name_to_idx: Dict[str, int],
        source_weights: np.ndarray,
        node_embeddings: Dict[str, np.ndarray],
        query_embedding: Optional[np.ndarray],
        alpha: float = 10.0,
        epsilon: float = 1e-6,
        max_iterations: int = 10000,
        step_size: float = 0.2,
        weight_scheme: str = "original",
        hybrid_a: float = 1.0,
        hybrid_b: float = 0.5,
        use_node_degree: bool = True,
        random_seed: int = 42,
        threshold: float = 1e-5,
        # ── Query-aware enhancements (all default OFF = original behaviour) ──
        sim_mode: str = "normalized",   # Similarity contrast: "normalized", "relu", "relu_sq"
        qa_sink_gamma: float = 0.0,     # query-aware sink capacity
        qa_warm_delta: float = 0.0,     # query-aware seed bias
        qa_warm_walk: bool = False,     # query-aware warm-start random walk (uses edge weights)
        qa_warm_steps: int = 2,         # number of warm-start steps (default 2)
        qa_accum_gamma: float = 0.0,    # query-aware x accumulation boost
    ):
        self.graph = graph
        self.node_name_to_idx = node_name_to_idx
        self.idx_to_node_name = {v: k for k, v in node_name_to_idx.items()}
        self.node_embeddings = node_embeddings or {}
        self.query_embedding = query_embedding
        self.alpha = alpha
        self.epsilon = epsilon
        self.max_iterations = max_iterations
        self.step_size = step_size
        self.weight_scheme = weight_scheme
        self.hybrid_a = hybrid_a
        self.hybrid_b = hybrid_b
        self.use_node_degree = use_node_degree
        self.sim_mode = sim_mode
        self.qa_sink_gamma = qa_sink_gamma
        self.qa_warm_delta = qa_warm_delta
        self.qa_warm_walk = qa_warm_walk
        self.qa_accum_gamma = qa_accum_gamma

        n = len(node_name_to_idx)

        # Precompute per-node query similarity (used by QA push selection, sink, warm)
        self._node_query_sim = np.zeros(n)
        if query_embedding is not None and node_embeddings and weight_scheme != "none":
            for i in range(n):
                name = self.idx_to_node_name.get(i)
                if name:
                    emb = self.node_embeddings.get(name)
                    if emb is not None:
                        self._node_query_sim[i] = _cosine_similarity(emb, query_embedding, mode=sim_mode)

        # Normalise source weights (threshold small values, then normalise)
        sw = np.copy(source_weights).astype(np.float64)
        sw[sw < threshold] = 0.0
        sw_sum = np.sum(sw)
        if sw_sum > 0:
            sw /= sw_sum
        else:
            sw = np.ones(n) / n
        self.source_weights = sw

        # State arrays
        self.mass = np.zeros(n)
        self.sink_capacity = np.zeros(n)
        self.x = np.zeros(n)

        # Edge weight cache
        self._edge_weight_cache: Dict[Tuple[int, int], float] = {}

        random.seed(random_seed)

        # Warm-start x: multi-step lazy random walk from seed distribution
        if qa_warm_delta > 0:
            x = self.source_weights * (1.0 + qa_warm_delta * self._node_query_sim)
            x_sum = np.sum(x)
            if x_sum > 0:
                x /= x_sum
        else:
            x = self.source_weights.copy()

        for _ in range(qa_warm_steps):
            x_new = np.zeros(n)
            for i in range(n):
                if x[i] > 0:
                    neighbors = self.graph.neighbors(i)
                    if not neighbors:
                        continue
                    if qa_warm_walk and query_embedding is not None:
                        # Query-aware walk: spread proportional to edge weights
                        weights = []
                        for j in neighbors:
                            w = self._get_edge_weight(i, j)
                            weights.append(w)
                        total_w = sum(weights)
                        if total_w > 0:
                            for j, w in zip(neighbors, weights):
                                x_new[j] += x[i] * w / total_w
                        else:
                            spread = x[i] / len(neighbors)
                            for j in neighbors:
                                x_new[j] += spread
                    else:
                        # Original: uniform spread
                        spread = x[i] / len(neighbors)
                        for j in neighbors:
                            x_new[j] += spread
            x = (self.source_weights + x_new) / 2.0
        self.x = x

    # ------------------------------------------------------------------
    def _get_edge_weight(self, i: int, j: int) -> float:
        """Get (cached) query-aware edge weight between node indices i and j."""
        key = (i, j)
        if key in self._edge_weight_cache:
            return self._edge_weight_cache[key]

        try:
            eid = self.graph.get_eid(i, j)
            attrs = self.graph.es[eid].attributes()
            w = attrs.get("weight", 1.0)
        except Exception:
            self._edge_weight_cache[key] = 0.0
            return 0.0

        if w <= 0:
            self._edge_weight_cache[key] = 0.0
            return 0.0

        # Query-aware modulation
        if self.weight_scheme == "none" or not self.node_embeddings or self.query_embedding is None:
            self._edge_weight_cache[key] = w
            return w

        n1 = self.idx_to_node_name.get(i)
        n2 = self.idx_to_node_name.get(j)
        if n1 is None or n2 is None:
            self._edge_weight_cache[key] = w
            return w

        e1 = self.node_embeddings.get(n1)
        e2 = self.node_embeddings.get(n2)
        if e1 is None and e2 is None:
            self._edge_weight_cache[key] = w
            return w

        zero = np.zeros_like(self.query_embedding)
        s1 = _cosine_similarity(e1 if e1 is not None else zero, self.query_embedding, mode=self.sim_mode)
        s2 = _cosine_similarity(e2 if e2 is not None else zero, self.query_embedding, mode=self.sim_mode)

        if self.weight_scheme == "multiply":
            # Product (Eq. 5b): w * sim(u,q) * sim(v,q)
            qw = w * s1 * s2
        elif self.weight_scheme == "add":
            # Mean (Eq. 5a): (w + sim(u,q) + sim(v,q)) / 3
            qw = (w + s1 + s2) / 3.0
        else:  # "original" = Hybrid (Eq. 5c)
            # w * (a + b * avg_query_sim)
            qf = (s1 + s2) / 2.0
            qw = w * (self.hybrid_a + self.hybrid_b * qf)

        self._edge_weight_cache[key] = qw
        return qw

    # ------------------------------------------------------------------
    def _initialize(self):
        """Set sink capacities and inject mass at seeds."""
        n = len(self.source_weights)

        if self.use_node_degree:
            for i in range(n):
                self.sink_capacity[i] = max(self.graph.degree(i), 1.0)
        else:
            self.sink_capacity[:] = 1.0

        total_sink = np.sum(self.sink_capacity)
        self.sink_capacity = 10.0 * self.sink_capacity / total_sink

        # Phase 1: query-aware sink capacity β€” relevant nodes absorb more
        if self.qa_sink_gamma > 0:
            self.sink_capacity *= (1.0 + self.qa_sink_gamma * self._node_query_sim)

        total_sink = np.sum(self.sink_capacity)

        # Inject mass at seeds
        self.mass[:] = 0.0
        for i in range(n):
            if self.source_weights[i] > 0:
                self.mass[i] = self.alpha * total_sink * self.source_weights[i]

    # ------------------------------------------------------------------
    def _get_structural_weight(self, i: int, j: int) -> float:
        """Get original (non-query-aware) edge weight."""
        try:
            eid = self.graph.get_eid(i, j)
            return self.graph.es[eid].attributes().get("weight", 1.0)
        except Exception:
            return 0.0

    def _push(self, node_idx: int) -> bool:
        """Push excess mass from node to neighbours.

        Decoupled accumulation/routing: x accumulates by structural degree
        (independent of query), mass routes by query-aware edge weights.
        This ensures query-aware modulation steers flow without penalising
        the accumulation rate at query-relevant nodes.
        """
        neighbors = self.graph.neighbors(node_idx)
        if not neighbors:
            return False

        # Query-aware weights (for routing)
        w_qa = 0.0
        for j in neighbors:
            w_qa += self._get_edge_weight(node_idx, j)

        if w_qa == 0:
            return False

        excess = self.mass[node_idx] - self.sink_capacity[node_idx]
        if excess <= 0:
            return False

        # Structural weights (for accumulation) β€” decoupled from QA
        w_struct = 0.0
        for j in neighbors:
            w_struct += self._get_structural_weight(node_idx, j)
        if w_struct == 0:
            w_struct = w_qa  # fallback

        # Accumulate importance based on STRUCTURAL degree (not QA)
        accum = self.step_size * excess / (w_struct + 1e-8)
        if self.qa_accum_gamma > 0:
            accum *= (1.0 + self.qa_accum_gamma * self._node_query_sim[node_idx])
        self.x[node_idx] += accum
        self.mass[node_idx] = self.sink_capacity[node_idx]

        # Route mass using QUERY-AWARE weights
        for j in neighbors:
            w_ij = self._get_edge_weight(node_idx, j)
            if w_ij > 0:
                self.mass[j] += excess * w_ij / (w_qa + 1e-8)

        return True

    # ------------------------------------------------------------------
    def run(self, batch_push: bool = False) -> np.ndarray:
        """Run push-relabel flow diffusion. Returns per-node scores (np.ndarray).

        batch_push: If True, process ALL excess nodes per iteration (parallel
        push-relabel). This makes edge weights effective because each iteration
        touches all excess nodes' edges, not just one random node's.
        """
        self._initialize()

        iterations = 0
        pushes = 0

        while iterations < self.max_iterations:
            iterations += 1

            # Find nodes with excess mass (vectorised)
            excess_mask = self.mass > (self.sink_capacity + self.epsilon)
            excess_indices = np.nonzero(excess_mask)[0]

            if len(excess_indices) == 0:
                logger.info(f"QAFD converged in {iterations} iters ({pushes} pushes)")
                break

            if batch_push:
                # Batch push: process ALL excess nodes in this iteration
                for node_idx in excess_indices:
                    if self._push(int(node_idx)):
                        pushes += 1
            elif self.query_embedding is not None and self.node_embeddings and len(self._node_query_sim) > 0:
                # Query-aware push: push from most query-relevant excess node
                qa_scores = self._node_query_sim[excess_indices]
                node_idx = int(excess_indices[np.argmax(qa_scores)])
                if self._push(node_idx):
                    pushes += 1
            else:
                # Random push (fallback when no query embedding)
                node_idx = int(random.choice(excess_indices))
                if self._push(node_idx):
                    pushes += 1

            if iterations % 10 == 0:
                remaining = np.sum(np.maximum(0, self.mass - self.sink_capacity))
                if remaining < self.epsilon:
                    logger.info(f"QAFD converged in {iterations} iters ({pushes} pushes)")
                    break

        if iterations >= self.max_iterations:
            logger.warning(f"QAFD did not converge after {self.max_iterations} iterations")

        logger.info(f"QAFD: {iterations} iters, {pushes} pushes, batch={batch_push}")
        return self.x


# ===========================================================================
# Convenience wrapper matching the interface used by retriever.py
# ===========================================================================

def run_igraph_qafd(
    graph,
    node_name_to_idx: Dict[str, int],
    passage_node_idxs: List[int],
    source_weights: np.ndarray,
    node_embeddings: Dict[str, np.ndarray],
    query_embedding: Optional[np.ndarray],
    alpha: float = 10.0,
    epsilon: float = 1e-6,
    max_iterations: int = 10000,
    step_size: float = 0.2,
    weight_scheme: str = "original",
    hybrid_a: float = 1.0,
    hybrid_b: float = 0.5,
    use_node_degree: bool = True,
    random_seed: int = 42,
    sim_mode: str = "normalized",
    qa_sink_gamma: float = 0.0,
    qa_warm_delta: float = 0.0,
    qa_warm_walk: bool = False,
    qa_warm_steps: int = 2,
    qa_accum_gamma: float = 0.0,
    qa_post_lambda: float = 0.0,
    batch_push: bool = False,
) -> Tuple[np.ndarray, np.ndarray]:
    """Run QAFD on igraph and return (sorted_doc_ids, sorted_doc_scores).

    sim_mode: Similarity contrast function ("normalized", "relu", "relu_sq")
    Query-aware enhancement flags (all default 0.0 = original behaviour):
        qa_sink_gamma:  Scale sink capacity by (1 + gamma * sim(node, query))
        qa_warm_delta:  Bias warm-start x toward query-relevant seeds
        qa_post_lambda: Rerank output by (1 + lambda * sim(passage, query))
    """
    qafd = IGraphQAFD(
        graph=graph,
        node_name_to_idx=node_name_to_idx,
        source_weights=source_weights,
        node_embeddings=node_embeddings,
        query_embedding=query_embedding,
        alpha=alpha,
        epsilon=epsilon,
        max_iterations=max_iterations,
        step_size=step_size,
        weight_scheme=weight_scheme,
        hybrid_a=hybrid_a,
        hybrid_b=hybrid_b,
        use_node_degree=use_node_degree,
        random_seed=random_seed,
        sim_mode=sim_mode,
        qa_sink_gamma=qa_sink_gamma,
        qa_warm_delta=qa_warm_delta,
        qa_warm_walk=qa_warm_walk,
        qa_warm_steps=qa_warm_steps,
        qa_accum_gamma=qa_accum_gamma,
    )

    node_scores = qafd.run(batch_push=batch_push)

    # Extract passage scores
    doc_scores = np.array([node_scores[idx] for idx in passage_node_idxs])

    # Phase 3: post-diffusion query-aware reranking
    if qa_post_lambda > 0 and query_embedding is not None and node_embeddings:
        idx_to_name = qafd.idx_to_node_name
        for pi, pidx in enumerate(passage_node_idxs):
            name = idx_to_name.get(pidx)
            if name:
                emb = node_embeddings.get(name)
                if emb is not None:
                    sim = _cosine_similarity(emb, query_embedding, mode=sim_mode)
                    doc_scores[pi] *= (1.0 + qa_post_lambda * sim)

    total = np.sum(doc_scores)
    if total > 0:
        doc_scores = doc_scores / total
    else:
        doc_scores = np.ones(len(doc_scores)) / max(len(doc_scores), 1)

    sorted_ids = np.argsort(doc_scores)[::-1]
    sorted_scores = doc_scores[sorted_ids]

    return sorted_ids, sorted_scores


# ===========================================================================
# Fast PPR via igraph (matches the original actual benchmark method)
# ===========================================================================

def run_ppr(
    graph,
    node_name_to_idx: Dict[str, int],
    passage_node_idxs: List[int],
    reset_prob: np.ndarray,
    damping: float = 0.5,
) -> Tuple[np.ndarray, np.ndarray]:
    """Run Personalized PageRank on igraph and return (sorted_doc_ids, sorted_doc_scores).

    This matches the original ``run_ppr()`` with ``use_qafd=False``.
    Uses igraph's C-based prpack implementation β€” converges instantly.
    """
    reset_prob = np.where(np.isnan(reset_prob) | (reset_prob < 0), 0, reset_prob)

    pagerank_scores = graph.personalized_pagerank(
        vertices=range(len(node_name_to_idx)),
        damping=damping,
        directed=False,
        weights="weight",
        reset=reset_prob,
        implementation="prpack",
    )

    doc_scores = np.array([pagerank_scores[idx] for idx in passage_node_idxs])

    sorted_ids = np.argsort(doc_scores)[::-1]
    sorted_scores = doc_scores[sorted_ids]

    return sorted_ids, sorted_scores