Skip to main content

Fast temporal negative edge sampler for graph neural networks

Project description

Temporal Negative Edge Sampler

PyPI Latest Release PyPI Downloads

The Problem:

Poursafaei et al. in NeurIPS 2022 described that random negative edges make temporal link prediction task easy. This is because random negatives are often between unrelated node pairs that have never interacted, making them trivially easy for models to distinguish from true positive edges. So they introduced the concept of historical negatives—edges that existed in the past but are inactive at the current time—making the prediction task more realistic and challenging.

Huang et al. in NeurIPS 2023 created a benchmark based on this called TGB (Temporal Graph Benchmark) where in the validation and test sets they included both historical and random negatives.

  • Historical negatives: Edges that existed in the past but are inactive at the current time between a pair of nodes.
  • Random negatives: Edges that never existed in the past between a pair of nodes.

TGB generated 10-20 negative edges per positive edge where 50% is historical and 50% is random.

However, they only released pre-generated pickle files with negatives for their benchmark datasets, and did not publish code to generate such negatives for new datasets or for training-time augmentation.

Negative edges are generated using the following steps:

  1. Group all edges by timestamp, sorted in chronological order.

  2. Iterate through each timestamp group (i.e., a batch of edges sharing the same timestamp):

    • Add the current batch to a streaming graph structure, which keeps track of all previously seen edges (the historical graph).
  3. For each source node in the current batch:

    • Sample n × p historical negative edges:
      • These are destination nodes that have been connected to the source in the past, but are not connected to the source in the current timestamp.
    • Sample n × (1 - p) random negative edges:
      • These are destination nodes that have never been connected to the source in the historical graph (including the current batch).

While the algorithm described above is correct and benchmark-aligned, it is computationally expensive if implemented naively in Python. A naive Python implementation will not scale to large datasets and may run indefinitely for even moderate-sized graphs.

Temporal Negative Edge Sampler is a high-performance library for generating negative edges in temporal link prediction tasks, supporting both historical and random negative sampling. It mirrors the evaluation strategy used in the Temporal Graph Benchmark (TGB), but extends it to training and custom datasets. The core implementation is written in parallelized C++ with Python bindings, making it scalable to large graphs with millions of edges.

API

collect_all_negatives_by_timestamp

Collects negative edges for temporal graph sampling, processing edges grouped by timestamp.

Signature

from temporal_negative_edge_sampler import collect_all_negatives_by_timestamp

collect_all_negatives_by_timestamp(
    sources: np.ndarray,
    targets: np.ndarray,
    timestamps: np.ndarray,
    is_directed: bool,
    num_negatives_per_positive: int,
    historical_negative_percentage: float = 0.5
) -> Tuple[np.ndarray, np.ndarray]

Parameters

  • sources (np.ndarray): Array of source node IDs
  • targets (np.ndarray): Array of target node IDs
  • timestamps (np.ndarray): Array of timestamps for each edge
  • is_directed (bool): Whether the graph is directed
  • num_negatives_per_positive (int): Number of negative edges to sample per positive edge
  • historical_negative_percentage (float, optional): Ratio of historical vs random negatives (default: 0.5)

References:

Poursafaei et al. (2022)
Towards Better Evaluation for Dynamic Link Prediction
Farimah Poursafaei, Shenyang Huang, Kris Pelrine, Reihaneh Rabbany
In NeurIPS 2022 Datasets and Benchmarks Track.
https://arxiv.org/pdf/2207.10128

Huang et al. (2023)
Temporal Graph Benchmark for Machine Learning on Temporal Graphs
Shenyang Huang, Farimah Poursafaei, Jacob Danovitch, Matthias Fey, Weihua Hu, Emanuele Rossi, Jure Leskovec, Michael Bronstein, Guillaume Rabusseau, Reihaneh Rabbany
In NeurIPS 2023 Datasets and Benchmarks Track.
https://arxiv.org/pdf/2307.01026

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

temporal_negative_edge_sampler-0.1.13-cp311-cp311-manylinux_2_34_x86_64.whl (214.8 kB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ x86-64

temporal_negative_edge_sampler-0.1.13-cp310-cp310-manylinux_2_34_x86_64.whl (213.0 kB view details)

Uploaded CPython 3.10manylinux: glibc 2.34+ x86-64

temporal_negative_edge_sampler-0.1.13-cp39-cp39-manylinux_2_34_x86_64.whl (212.1 kB view details)

Uploaded CPython 3.9manylinux: glibc 2.34+ x86-64

temporal_negative_edge_sampler-0.1.13-cp38-cp38-manylinux_2_34_x86_64.whl (212.0 kB view details)

Uploaded CPython 3.8manylinux: glibc 2.34+ x86-64

File details

Details for the file temporal_negative_edge_sampler-0.1.13-cp311-cp311-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for temporal_negative_edge_sampler-0.1.13-cp311-cp311-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 aeda7366d76a6fe73217aa3487c65d5d9d75003cb2fc0dc21dff259d5d110b03
MD5 7debd6a378331cffa4999eae4791b762
BLAKE2b-256 173703a8aa2cc857b95aab843614f26102b6d4429191842b05b22316c350a9aa

See more details on using hashes here.

File details

Details for the file temporal_negative_edge_sampler-0.1.13-cp310-cp310-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for temporal_negative_edge_sampler-0.1.13-cp310-cp310-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 2ed9c55d3df22d17e1e5f1fd774886228741f25105c783c9940fa2b2869e51c2
MD5 134bd10a6eae4d8a7c5cb4fa65ffef49
BLAKE2b-256 22ef2223fa413b1041fd25ac199a35d8c999b335b673cc37baf7e27dd4ea2a63

See more details on using hashes here.

File details

Details for the file temporal_negative_edge_sampler-0.1.13-cp39-cp39-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for temporal_negative_edge_sampler-0.1.13-cp39-cp39-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 dfecbfb2de7fdab32cf0280e5319e68ff15e38bc8e57b30da2bd14652490b817
MD5 1e4f1b4c38f2ab995cd7513c6e37e324
BLAKE2b-256 567adc6bafdb49c0e4be41530213a7f2ac03ac8e26abe86e45134112cecd8ffc

See more details on using hashes here.

File details

Details for the file temporal_negative_edge_sampler-0.1.13-cp38-cp38-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for temporal_negative_edge_sampler-0.1.13-cp38-cp38-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 44f0a7b006a82432817ecaec542641b9b2311d6cb94b94f19362b83b8212de18
MD5 b5f2341851e14e9f4fbb4ffa63ce7d6e
BLAKE2b-256 61cdce60866df0ce2b2f1df3c9bf67beec6cec84ed1a52f72946081e695e750c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page