relbench 2.1.0__tar.gz → 2.1.2__tar.gz

{relbench-2.1.0 → relbench-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: relbench
-Version: 2.1.0
+Version: 2.1.2
 Summary: RelBench: Relational Deep Learning Benchmark
 Keywords: 
 Author-email: RelBench Team <relbench@cs.stanford.edu>
@@ -18,6 +18,7 @@ Requires-Dist: typing-extensions
 Requires-Dist: datasets
 Requires-Dist: redelex ; extra == "ctu"
 Requires-Dist: dbinfer-relbench-adapter ; extra == "dbinfer"
+Requires-Dist: db-dtypes ; extra == "dbinfer"
 Requires-Dist: pre-commit ; extra == "dev"
 Requires-Dist: sentence-transformers ; extra == "example"
 Requires-Dist: pytorch_frame[full] ; extra == "example"
@@ -48,7 +49,7 @@ Provides-Extra: test
 
 
 <!-- [<img align="center" src="https://relbench.stanford.edu/img/favicon.png" width="20px" />   -->
-[**Website**](https://relbench.stanford.edu) | [**Position Paper**](https://proceedings.mlr.press/v235/fey24a.html) |  [**Benchmark Paper**](https://arxiv.org/abs/2407.20060) | [**Mailing List**](https://groups.google.com/forum/#!forum/relbench/join)
+[**Website**](https://relbench.stanford.edu) | [**Position Paper**](https://proceedings.mlr.press/v235/fey24a.html) |  [**RelBench v1 Paper**](https://arxiv.org/abs/2407.20060) | [**RelBench v2 Paper**](https://arxiv.org/abs/2602.12606) | [**Mailing List**](https://groups.google.com/forum/#!forum/relbench/join)
 
 # News
 
@@ -124,7 +125,30 @@ pip install relbench
 
 This will allow usage of the core RelBench data and task loading functionality.
 
-<details markdown="1"><summary>Including CTU datasets</summary>
+
+To additionally use `relbench.modeling`, which requires [PyTorch](https://pytorch.org/), [PyTorch Geometric](https://github.com/pyg-team/pytorch_geometric) and [PyTorch Frame](https://github.com/pyg-team/pytorch-frame), install these dependencies manually or do:
+
+```bash
+pip install relbench[full]
+```
+
+
+For the scripts in the `examples` directory, use:
+```bash
+pip install relbench[example]
+```
+
+Then, to run a script:
+```bash
+git clone https://github.com/snap-stanford/relbench
+cd relbench/examples
+python gnn_entity.py --dataset rel-f1 --task driver-position
+```
+
+
+## Using External Integrations
+
+**Using CTU datasets**
 
 To use datasets from the CTU repository, use:
 ```bash
@@ -133,7 +157,7 @@ pip install relbench[ctu]
 
 If you use the CTU datasets in your work, please cite [ReDeLEx](https://github.com/jakubpeleska/redelex) as below:
 
-```
+```bibtex
 @misc{peleska2025redelex,
   title={REDELEX: A Framework for Relational Deep Learning Exploration},
   author={Jakub Peleška and Gustav Šír},
@@ -145,9 +169,9 @@ If you use the CTU datasets in your work, please cite [ReDeLEx](https://github.c
 }
 ```
 
-</details>
 
-<details markdown="1"><summary>Including 4DBInfer datasets</summary>
+
+**Using 4DBInfer datasets**
 
 To use datasets from the 4DBInfer repository, use:
 ```bash
@@ -155,7 +179,7 @@ pip install relbench[dbinfer]
 ```
 
 If you use the 4DBInfer datasets in your work, please cite [4DBInfer](https://github.com/awslabs/multi-table-benchmark) as below:
-```
+```bibtex
 @article{dbinfer,
   title={4DBInfer: A 4D Benchmarking Toolbox for Graph-Centric Predictive Modeling on Relational DBs},
   author={Wang, Minjie and Gan, Quan and Wipf, David and Cai, Zhenkun and Li, Ning and Tang, Jianheng and Zhang, Yanlin and Zhang, Zizhao and Mao, Zunyao and Song, Yakun and Wang, Yanbo and Li, Jiahang and Zhang, Han and Yang, Guang and Qin, Xiao and Lei, Chuan and Zhang, Muhan and Zhang, Weinan and Faloutsos, Christos and Zhang, Zheng},
@@ -164,28 +188,29 @@ If you use the 4DBInfer datasets in your work, please cite [4DBInfer](https://gi
 }
 ```
 
-</details>
-<br>
-
+**Using TGB datasets**
 
-To additionally use `relbench.modeling`, which requires [PyTorch](https://pytorch.org/), [PyTorch Geometric](https://github.com/pyg-team/pytorch_geometric) and [PyTorch Frame](https://github.com/pyg-team/pytorch-frame), install these dependencies manually or do:
+[TGB](https://tgb.complexdatalab.com/) datasets and tasks can be loaded in the RelBench format, and they cover bipartite link prediction (`tgbl-*`), heterogeneous link prediction (`thgl-*`), and node property prediction (`tgbn-*`). See `relbench/tasks/tgb.py` for the official TGB evaluation protocols (one-vs-many MRR / Hits@10 for link prediction, NDCG@10 for node property prediction). Standard RelBench style evaluation works as it is.
 
-```bash
-pip install relbench[full]
+If you use the TGB datasets in your work, please cite [TGB](https://tgb.complexdatalab.com/) as below:
+```bibtex
+@article{huang2023temporal,
+  title={Temporal graph benchmark for machine learning on temporal graphs},
+  author={Huang, Shenyang and Poursafaei, Farimah and Danovitch, Jacob and Fey, Matthias and Hu, Weihua and Rossi, Emanuele and Leskovec, Jure and Bronstein, Michael and Rabusseau, Guillaume and Rabbany, Reihaneh},
+  journal={Advances in Neural Information Processing Systems},
+  year={2023}
+}
 ```
 
-
-For the scripts in the `examples` directory, use:
-```bash
-pip install relbench[example]
+```bibtex
+@article{huang2024tgb2,
+  title={TGB 2.0: A Benchmark for Learning on Temporal Knowledge Graphs and Heterogeneous Graphs},
+  author={Gastinger, Julia and Huang, Shenyang and Galkin, Mikhail and Loghmani, Erfan and Parviz, Ali and Poursafaei, Farimah and Danovitch, Jacob and Rossi, Emanuele and Koutis, Ioannis and Stuckenschmidt, Heiner and      Rabbany, Reihaneh and Rabusseau, Guillaume},
+  journal={Advances in Neural Information Processing Systems},
+  year={2024}
+}
 ```
 
-Then, to run a script:
-```bash
-git clone https://github.com/snap-stanford/relbench
-cd relbench/examples
-python gnn_entity.py --dataset rel-f1 --task driver-position
-```
 
 
 # Package Usage

{relbench-2.1.0 → relbench-2.1.2}/README.md

@@ -12,7 +12,7 @@
 
 
 <!-- [<img align="center" src="https://relbench.stanford.edu/img/favicon.png" width="20px" />   -->
-[**Website**](https://relbench.stanford.edu) | [**Position Paper**](https://proceedings.mlr.press/v235/fey24a.html) |  [**Benchmark Paper**](https://arxiv.org/abs/2407.20060) | [**Mailing List**](https://groups.google.com/forum/#!forum/relbench/join)
+[**Website**](https://relbench.stanford.edu) | [**Position Paper**](https://proceedings.mlr.press/v235/fey24a.html) |  [**RelBench v1 Paper**](https://arxiv.org/abs/2407.20060) | [**RelBench v2 Paper**](https://arxiv.org/abs/2602.12606) | [**Mailing List**](https://groups.google.com/forum/#!forum/relbench/join)
 
 # News
 
@@ -88,7 +88,30 @@ pip install relbench
 
 This will allow usage of the core RelBench data and task loading functionality.
 
-<details markdown="1"><summary>Including CTU datasets</summary>
+
+To additionally use `relbench.modeling`, which requires [PyTorch](https://pytorch.org/), [PyTorch Geometric](https://github.com/pyg-team/pytorch_geometric) and [PyTorch Frame](https://github.com/pyg-team/pytorch-frame), install these dependencies manually or do:
+
+```bash
+pip install relbench[full]
+```
+
+
+For the scripts in the `examples` directory, use:
+```bash
+pip install relbench[example]
+```
+
+Then, to run a script:
+```bash
+git clone https://github.com/snap-stanford/relbench
+cd relbench/examples
+python gnn_entity.py --dataset rel-f1 --task driver-position
+```
+
+
+## Using External Integrations
+
+**Using CTU datasets**
 
 To use datasets from the CTU repository, use:
 ```bash
@@ -97,7 +120,7 @@ pip install relbench[ctu]
 
 If you use the CTU datasets in your work, please cite [ReDeLEx](https://github.com/jakubpeleska/redelex) as below:
 
-```
+```bibtex
 @misc{peleska2025redelex,
   title={REDELEX: A Framework for Relational Deep Learning Exploration},
   author={Jakub Peleška and Gustav Šír},
@@ -109,9 +132,9 @@ If you use the CTU datasets in your work, please cite [ReDeLEx](https://github.c
 }
 ```
 
-</details>
 
-<details markdown="1"><summary>Including 4DBInfer datasets</summary>
+
+**Using 4DBInfer datasets**
 
 To use datasets from the 4DBInfer repository, use:
 ```bash
@@ -119,7 +142,7 @@ pip install relbench[dbinfer]
 ```
 
 If you use the 4DBInfer datasets in your work, please cite [4DBInfer](https://github.com/awslabs/multi-table-benchmark) as below:
-```
+```bibtex
 @article{dbinfer,
   title={4DBInfer: A 4D Benchmarking Toolbox for Graph-Centric Predictive Modeling on Relational DBs},
   author={Wang, Minjie and Gan, Quan and Wipf, David and Cai, Zhenkun and Li, Ning and Tang, Jianheng and Zhang, Yanlin and Zhang, Zizhao and Mao, Zunyao and Song, Yakun and Wang, Yanbo and Li, Jiahang and Zhang, Han and Yang, Guang and Qin, Xiao and Lei, Chuan and Zhang, Muhan and Zhang, Weinan and Faloutsos, Christos and Zhang, Zheng},
@@ -128,28 +151,29 @@ If you use the 4DBInfer datasets in your work, please cite [4DBInfer](https://gi
 }
 ```
 
-</details>
-<br>
-
+**Using TGB datasets**
 
-To additionally use `relbench.modeling`, which requires [PyTorch](https://pytorch.org/), [PyTorch Geometric](https://github.com/pyg-team/pytorch_geometric) and [PyTorch Frame](https://github.com/pyg-team/pytorch-frame), install these dependencies manually or do:
+[TGB](https://tgb.complexdatalab.com/) datasets and tasks can be loaded in the RelBench format, and they cover bipartite link prediction (`tgbl-*`), heterogeneous link prediction (`thgl-*`), and node property prediction (`tgbn-*`). See `relbench/tasks/tgb.py` for the official TGB evaluation protocols (one-vs-many MRR / Hits@10 for link prediction, NDCG@10 for node property prediction). Standard RelBench style evaluation works as it is.
 
-```bash
-pip install relbench[full]
+If you use the TGB datasets in your work, please cite [TGB](https://tgb.complexdatalab.com/) as below:
+```bibtex
+@article{huang2023temporal,
+  title={Temporal graph benchmark for machine learning on temporal graphs},
+  author={Huang, Shenyang and Poursafaei, Farimah and Danovitch, Jacob and Fey, Matthias and Hu, Weihua and Rossi, Emanuele and Leskovec, Jure and Bronstein, Michael and Rabusseau, Guillaume and Rabbany, Reihaneh},
+  journal={Advances in Neural Information Processing Systems},
+  year={2023}
+}
 ```
 
-
-For the scripts in the `examples` directory, use:
-```bash
-pip install relbench[example]
+```bibtex
+@article{huang2024tgb2,
+  title={TGB 2.0: A Benchmark for Learning on Temporal Knowledge Graphs and Heterogeneous Graphs},
+  author={Gastinger, Julia and Huang, Shenyang and Galkin, Mikhail and Loghmani, Erfan and Parviz, Ali and Poursafaei, Farimah and Danovitch, Jacob and Rossi, Emanuele and Koutis, Ioannis and Stuckenschmidt, Heiner and      Rabbany, Reihaneh and Rabusseau, Guillaume},
+  journal={Advances in Neural Information Processing Systems},
+  year={2024}
+}
 ```
 
-Then, to run a script:
-```bash
-git clone https://github.com/snap-stanford/relbench
-cd relbench/examples
-python gnn_entity.py --dataset rel-f1 --task driver-position
-```
 
 
 # Package Usage

{relbench-2.1.0 → relbench-2.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "relbench"
-version = "2.1.0"
+version = "2.1.2"
 description = "RelBench: Relational Deep Learning Benchmark"
 authors = [{name = "RelBench Team", email = "relbench@cs.stanford.edu"}]
 readme = "README.md"
@@ -44,6 +44,7 @@ dev=[
 ]
 dbinfer=[
 	"dbinfer-relbench-adapter",
+	"db-dtypes",
 ]
 ctu=[
 	"redelex",

{relbench-2.1.0 → relbench-2.1.2}/relbench/base/table.py

@@ -84,6 +84,11 @@ class Table:
         # Read the Parquet file using pyarrow
         table = pa.parquet.read_table(path)
         df = table.to_pandas()
+        # DuckDB currently cannot ingest pandas StringDtype columns reliably.
+        # Convert them to plain object dtype on load.
+        for col in df.columns:
+            if isinstance(df[col].dtype, pd.StringDtype):
+                df[col] = df[col].astype(object)
 
         # Extract metadata
         metadata_bytes = table.schema.metadata

{relbench-2.1.0 → relbench-2.1.2}/relbench/base/task_autocomplete.py

@@ -173,8 +173,7 @@ class AutoCompleteTask(EntityTask):
         min_timestamp = timestamp_df["timestamp"].min()
         max_timestamp = timestamp_df["timestamp"].max()
 
-        df = duckdb.sql(
-            f"""
+        df = duckdb.sql(f"""
             SELECT
                 entity_table.{self.time_col},
                 entity_table.{entity_col},
@@ -188,8 +187,7 @@ class AutoCompleteTask(EntityTask):
             WHERE
                 entity_table.{self.time_col} > '{min_timestamp}' AND
                 entity_table.{self.time_col} <= '{max_timestamp}'
-            """
-        ).df()
+            """).df()
 
         if self.task_type == TaskType.MULTICLASS_CLASSIFICATION:
             df[self.target_col] = self.transform_target(df[self.target_col])

{relbench-2.1.0 → relbench-2.1.2}/relbench/base/task_recommendation.py

@@ -83,6 +83,9 @@ class RecommendationTask(BaseTask):
                 f"{pred.shape} given."
             )
 
+        if len(target_table) == 0:
+            return {fn.__name__: float("nan") for fn in metrics}
+
         pred_isin_list = []
         dst_count_list = []
         for true_dst_nodes, pred_dst_nodes in zip(

{relbench-2.1.0 → relbench-2.1.2}/relbench/datasets/__init__.py

@@ -18,6 +18,7 @@ from relbench.datasets import (
     ratebeer,
     salt,
     stack,
+    tgb,
     trial,
 )
 from relbench.utils import get_relbench_cache_dir
@@ -70,15 +71,8 @@ def download_dataset(name: str) -> None:
     The downloaded database will be automatically picked up by the dataset object, when
     `dataset.get_db()` is called.
     """
-    if name.startswith("dbinfer-"):
-        print(
-            f"Dataset '{name}' is derived from 4DBInfer and must be generated "
-            "locally; skipping download."
-        )
-        return
 
     if name == "rel-mimic":
-        print("Downloading Mimic dataset...")
         from relbench.datasets.mimic import verify_mimic_access
 
         verify_mimic_access()
@@ -126,6 +120,8 @@ def get_dataset(name: str, download=True) -> Dataset:
     if name == "rel-mimic":
         from relbench.datasets import mimic
 
+        mimic.verify_mimic_access()
+
         cls, args, kwargs = (
             mimic.MimicDataset,
             (),
@@ -150,10 +146,29 @@ register_dataset("rel-arxiv", arxiv.ArxivDataset)
 register_dataset("rel-salt", salt.SALTDataset)
 register_dataset("rel-ratebeer", ratebeer.RateBeerDataset)
 register_dataset("dbinfer-avs", dbinfer.DBInferAVSDataset)
-register_dataset("dbinfer-mag", dbinfer.DBInferMAGDataset)
+# register_dataset("dbinfer-mag", dbinfer.DBInferMAGDataset)    # Experimental dataset: dbinfer-mag
 register_dataset("dbinfer-diginetica", dbinfer.DBInferDigineticaDataset)
 register_dataset("dbinfer-retailrocket", dbinfer.DBInferRetailRocketDataset)
 register_dataset("dbinfer-seznam", dbinfer.DBInferSeznamDataset)
 register_dataset("dbinfer-amazon", dbinfer.DBInferAmazonDataset)
 register_dataset("dbinfer-stackexchange", dbinfer.DBInferStackExchangeDataset)
 register_dataset("dbinfer-outbrain-small", dbinfer.DBInferOutbrainSmallDataset)
+
+# Temporal Graph Benchmark (TGB)
+register_dataset("tgbl-wiki", tgb.TGBDataset, tgb_name="tgbl-wiki")
+register_dataset("tgbl-wiki-v2", tgb.TGBDataset, tgb_name="tgbl-wiki-v2")
+register_dataset("tgbl-review", tgb.TGBDataset, tgb_name="tgbl-review")
+register_dataset("tgbl-review-v2", tgb.TGBDataset, tgb_name="tgbl-review-v2")
+register_dataset("tgbl-coin", tgb.TGBDataset, tgb_name="tgbl-coin")
+register_dataset("tgbl-comment", tgb.TGBDataset, tgb_name="tgbl-comment")
+register_dataset("tgbl-flight", tgb.TGBDataset, tgb_name="tgbl-flight")
+
+register_dataset("thgl-software", tgb.TGBDataset, tgb_name="thgl-software")
+register_dataset("thgl-forum", tgb.TGBDataset, tgb_name="thgl-forum")
+register_dataset("thgl-github", tgb.TGBDataset, tgb_name="thgl-github")
+register_dataset("thgl-myket", tgb.TGBDataset, tgb_name="thgl-myket")
+
+register_dataset("tgbn-trade", tgb.TGBDataset, tgb_name="tgbn-trade")
+register_dataset("tgbn-genre", tgb.TGBDataset, tgb_name="tgbn-genre")
+register_dataset("tgbn-reddit", tgb.TGBDataset, tgb_name="tgbn-reddit")
+register_dataset("tgbn-token", tgb.TGBDataset, tgb_name="tgbn-token")

{relbench-2.1.0 → relbench-2.1.2}/relbench/datasets/dbinfer.py

@@ -38,7 +38,18 @@ class DBInferDatasetBase(Dataset):
         self._adapter_cache_dir = adapter_cache_dir
 
     def _load_dataset_adapter(self):
-        from dbinfer_relbench_adapter.loader import load_dbinfer_data
+        try:
+            from dbinfer_relbench_adapter.loader import load_dbinfer_data
+        except ImportError:
+            raise ImportError(
+                "dbinfer-relbench-adapter is not installed. "
+                "Please install it with:\n"
+                "  pip install dbinfer-relbench-adapter\n"
+                "  pip install dgl --force-reinstall -f https://data.dgl.ai/wheels/torch-2.3/cu121/repo.html\n"
+                "Note: dgl may conflict with other dependencies. We recommend building "
+                "dbinfer datasets in a separate virtual environment and using the cached "
+                "datasets in your main working environment."
+            ) from None
 
         dataset_adapter, _ = load_dbinfer_data(
             dataset_name=self.dbinfer_name,

relbench-2.1.2/relbench/datasets/hashes.json

@@ -0,0 +1,38 @@
+{
+  "rel-trial/db.zip": "9fb5ba14f7cbca8115f3dfe0800415f98d6ddc15561e56c35ee614da6b89552a",
+  "rel-avito/db.zip": "274e692295027a753063b9201815a9d2dea94d4cda968be81be936f546d77058",
+  "rel-stack/db.zip": "5a97bf65a926529143e96f6413b2b0550ca55c01247f85156bfb999ee903e94e",
+  "rel-f1/db.zip": "ec31a4e1bc2b2f9c36c05fcd3dfe2a40a506f335dc51ce79c3ec8bb40feb1482",
+  "rel-hm/db.zip": "3fb2aa3c978cc388aa81f43f9404fed329b502104ff58f3ee435959ab95e7029",
+  "rel-event/db.zip": "2593477065e1090af0258c07769ec22f40dad01f035613ccf35258b924d8b066",
+  "rel-amazon/db.zip": "db71c7701b892a4eb7481ff04d14d25465795501dba3a5931aabee9930805efe",
+  "rel-salt/db.zip": "fca91ab7d9e37646dcf1cb0007cc4229e9b23ef3c85f3c9e578d0f3fcb167001",
+  "rel-mimic/db.zip": "b41c6fa39e9d37b8e1e66f8311eb44622c79ea1644ee2cce280fc731d8366bbb",
+  "rel-arxiv/db.zip": "b7db1bc1aa17a6d79e0cf102fe3f258920a610f58ad8f8891169676fc120bc5c",
+  "rel-ratebeer/db.zip": "49afdf23a8b464dc0e54731a3782b51e53f3acee93dae0aa6d968cfbd9caa4be",
+  "dbinfer-amazon/db.zip": "0d9291bf880b5afa232b711a462ed7522a94a0ef5c141699ee8a2687dbbf0d08",
+  "dbinfer-avs/db.zip": "84295768a283c3c9ee0dbb25eb1c47d6d3f2c1956b523e7361f086fcf6664a93",
+  "dbinfer-diginetica/db.zip": "396e2aeb88cc616672b3b0d88a02dc13829c81b855edc3e668f7f2dbad3b96f0",
+  "dbinfer-outbrain-small/db.zip": "d186a71fc534bcac4299c616110805a997fa56fd16c15110d02e1c8eb3975210",
+  "dbinfer-retailrocket/db.zip": "6dbe83488e11c0d159b4592aa4cff57f6fa22b9f4bbf4ae38d0388d536897d75",
+  "dbinfer-seznam/db.zip": "77314bf874dc495e8a4a61f2dc5f12982bbec3c5b6b7af5555e9a2bb587154d9",
+  "dbinfer-stackexchange/db.zip": "4c8b8ac38b56d57bc2ead3c12be1237b69cae76062ed3f176fc02ad327a84d19",
+
+  "tgbl-coin/db.zip": "6de3b62bcfc59bb18ff8de0614ce5cbcf21179ad56cb58920d25ade32ec43e00",
+  "tgbl-comment/db.zip": "4eb41776954efa2cb06cdb64e093b182335b8683e60236a6645cf4bcd83597be",
+  "tgbl-flight/db.zip": "e82646893a45be6c5312e5dc1a774c08d929ecb9eb309c0ad9fdec6dae3b156a",
+  "tgbl-review/db.zip": "63b405aafd8092cbda297694e649329ca806ccc3c49c8e6f53eb4a3c19075091",
+  "tgbl-review-v2/db.zip": "a5f1a7a9661a700ebb1a3b43df74037853ad3bd6ed54c74342045d2dc8448bc2",
+  "tgbl-wiki/db.zip": "ad7b55d1d7b7125c06588db0b8cbebe87c629a95a6c9a911369f89aca9dffdc9",
+  "tgbl-wiki-v2/db.zip": "5eb56f8e459405e3b554ce56585903c80038d84a99ca4333b00ce32c8c7a38f1",
+
+  "tgbn-genre/db.zip": "e46aecc28315ca9872117817ce65bc1f4d00ed261ab6d35038a84bcf0ebab7bf",
+  "tgbn-reddit/db.zip": "bc444f5cbaf7004ef7c6c8f98ae12ae72e8427ccc9710e96e46b0fc156cc952e",
+  "tgbn-token/db.zip": "44a0f90a62642b8054ef1fbee35c862a67e5d0cec92f08b8fd44c503e0986be8",
+  "tgbn-trade/db.zip": "8a983ae6281ea058dc8d84f6ce339d2dacf0ae9bb98bb82cca3fed54ec3fe370",
+
+  "thgl-forum/db.zip": "fdb20c1afc542e8026b85df850b5e8a539694c182eb4530924fad65964461256",
+  "thgl-github/db.zip": "f69c1d49779a4dbead101e7325447854c8890982d254efb2b722117819ba8304",
+  "thgl-myket/db.zip": "67a3af25553ceabe8a7eff8906c2213bd82e932cdaeb48ffa326b39d30e0f0cf",
+  "thgl-software/db.zip": "35816ef6a07be2291349f081814e18b498a2e46e006ed21be36fdb1a8a0eb90d"
+}

{relbench-2.1.0 → relbench-2.1.2}/relbench/datasets/mimic.py

@@ -26,6 +26,15 @@ def verify_mimic_access() -> None:
     except Exception as e:
         raise RuntimeError(
             f"\nACCESS FAILED - BigQuery credential check encountered an error: {e}"
+            "\n\nTo gain access to MIMIC-IV via RelBench:"
+            "\n  1. Request access at https://physionet.org/content/mimiciv/"
+            "\n     and complete the 'Request access using Google BigQuery' step."
+            "\n  2. Install the Google Cloud SDK: https://cloud.google.com/sdk/docs/install"
+            "\n  3. Authenticate:  gcloud auth application-default login"
+            "\n  4. Set quota project:  gcloud auth application-default set-quota-project YOUR_PROJECT_ID"
+            "\n  5. Export your project ID:  export PROJECT_ID=YOUR_PROJECT_ID"
+            "\n  6. If credentials are not at the default path, set:"
+            "\n       export GOOGLE_APPLICATION_CREDENTIALS=/path/to/application_default_credentials.json"
         )
 
 
@@ -74,7 +83,9 @@ def convert_dtypes(df: pd.DataFrame) -> pd.DataFrame:
             or "time" in col.lower()
         ):
             try:
-                df[col] = pd.to_datetime(df[col], errors="coerce")
+                df[col] = pd.to_datetime(df[col], errors="coerce").astype(
+                    "datetime64[ns]"
+                )
             except Exception:
                 print("WARNING ")
                 pass
@@ -111,6 +122,10 @@ class MimicDataset(Dataset):
     The dataset is anchored around ICU stays (`icustays`) and patients (`patients`) and constructs all other
     tables with respect to these entities.
 
+    Note: MIMIC-IV applies date shifting for patient privacy. Timestamps are offset by a
+    random amount (typically decades) while preserving relative ordering. Expect dates
+    in the 2110-2200 range rather than the original 2008-2012 collection period.
+
     If certain parameters are not provided, default values will be used.
 
     Parameters:

relbench-2.1.2/relbench/datasets/tgb.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Optional
+
+import pandas as pd
+
+from relbench.base import Database, Dataset
+
+
+@dataclass(frozen=True)
+class TGBCutoffs:
+    val_timestamp_s: int
+    test_timestamp_s: int
+
+
+_TGB_CUTOFFS: dict[str, TGBCutoffs] = {
+    "tgbl-wiki": TGBCutoffs(val_timestamp_s=1862653, test_timestamp_s=2218300),
+    "tgbl-wiki-v2": TGBCutoffs(val_timestamp_s=1862653, test_timestamp_s=2218300),
+    "tgbl-review": TGBCutoffs(val_timestamp_s=1464912000, test_timestamp_s=1488844800),
+    "tgbl-review-v2": TGBCutoffs(
+        val_timestamp_s=1464912000, test_timestamp_s=1488844800
+    ),
+    "tgbl-coin": TGBCutoffs(val_timestamp_s=1662096249, test_timestamp_s=1664482319),
+    "tgbl-comment": TGBCutoffs(val_timestamp_s=1282869285, test_timestamp_s=1288838725),
+    "tgbl-flight": TGBCutoffs(val_timestamp_s=1638162000, test_timestamp_s=1653796800),
+    "thgl-software": TGBCutoffs(
+        val_timestamp_s=1706003880, test_timestamp_s=1706315669
+    ),
+    "thgl-forum": TGBCutoffs(val_timestamp_s=1390426563, test_timestamp_s=1390838358),
+    "thgl-github": TGBCutoffs(val_timestamp_s=1711075987, test_timestamp_s=1711482874),
+    "thgl-myket": TGBCutoffs(val_timestamp_s=1603724860, test_timestamp_s=1606341312),
+    "tgbn-trade": TGBCutoffs(val_timestamp_s=1262304000, test_timestamp_s=1388534400),
+    "tgbn-genre": TGBCutoffs(val_timestamp_s=1216427762, test_timestamp_s=1230448684),
+    "tgbn-reddit": TGBCutoffs(val_timestamp_s=1279485233, test_timestamp_s=1286653871),
+    "tgbn-token": TGBCutoffs(val_timestamp_s=1522889022, test_timestamp_s=1525386888),
+}
+
+
+class TGBDataset(Dataset):
+    r"""Temporal Graph Benchmark (TGB) datasets exported to RelBench format."""
+
+    url = "https://tgb.complexdatalab.com/"
+
+    def __init__(self, *, tgb_name: str, cache_dir: Optional[str] = None) -> None:
+        if tgb_name not in _TGB_CUTOFFS:
+            raise ValueError(
+                f"Unknown tgb_name='{tgb_name}'. Known keys: {sorted(_TGB_CUTOFFS.keys())}"
+            )
+        self.tgb_name = str(tgb_name)
+
+        cutoffs = _TGB_CUTOFFS[self.tgb_name]
+        self.val_timestamp = pd.to_datetime(
+            int(cutoffs.val_timestamp_s), unit="s", utc=True
+        )
+        self.test_timestamp = pd.to_datetime(
+            int(cutoffs.test_timestamp_s), unit="s", utc=True
+        )
+
+        super().__init__(cache_dir=cache_dir)
+
+    def make_db(self) -> Database:
+        if self.cache_dir is None:
+            raise RuntimeError("TGBDataset requires cache_dir to locate the cached db.")
+
+        db_dir = Path(self.cache_dir) / "db"
+        if db_dir.exists() and any(db_dir.glob("*.parquet")):
+            return Database.load(db_dir)
+
+        raise RuntimeError(
+            f"TGB dataset '{self.tgb_name}' not found at {db_dir}. "
+            "This dataset is distributed as a pre-built RelBench database (db.zip). "
+            "Please run `download_dataset(...)` or place `db/*.parquet` in the cache directory."
+        )

{relbench-2.1.0 → relbench-2.1.2}/relbench/modeling/loader.py

@@ -8,7 +8,7 @@ from torch_geometric.data import Data, FeatureStore, GraphStore, HeteroData
 from torch_geometric.loader import NodeLoader
 from torch_geometric.sampler import NeighborSampler, NodeSamplerInput
 from torch_geometric.sampler.base import SubgraphType
-from torch_geometric.typing import EdgeType, NodeType, OptTensor
+from torch_geometric.typing import WITH_PYG_LIB, EdgeType, NodeType, OptTensor
 
 
 def batched_arange(count: Tensor) -> Tuple[Tensor, Tensor]:
@@ -201,7 +201,10 @@ class LinkNeighborLoader(DataLoader):
             data,
             num_neighbors=num_neighbors,
             subgraph_type=subgraph_type,
-            disjoint=True,
+            # PyG only supports `disjoint=True` sampling with `pyg-lib`
+            # (as of torch_geometric==2.7.*). Fall back to `disjoint=False` to
+            # keep RelBench functional in environments without `pyg-lib`.
+            disjoint=WITH_PYG_LIB,
             temporal_strategy=temporal_strategy,
             time_attr=time_attr,
             share_memory=kwargs.get("num_workers", 0) > 0,

{relbench-2.1.0 → relbench-2.1.2}/relbench/modeling/nn.py

@@ -5,7 +5,13 @@ import torch_frame
 from torch import Tensor
 from torch_frame.data.stats import StatType
 from torch_frame.nn.models import ResNet
-from torch_geometric.nn import HeteroConv, LayerNorm, PositionalEncoding, SAGEConv
+from torch_geometric.nn import (
+    GATv2Conv,
+    HeteroConv,
+    LayerNorm,
+    PositionalEncoding,
+    SAGEConv,
+)
 from torch_geometric.typing import EdgeType, NodeType
 
 
@@ -171,3 +177,64 @@ class HeteroGraphSAGE(torch.nn.Module):
             x_dict = {key: x.relu() for key, x in x_dict.items()}
 
         return x_dict
+
+
+class HeteroGAT(torch.nn.Module):
+    def __init__(
+        self,
+        node_types: List[NodeType],
+        edge_types: List[EdgeType],
+        channels: int,
+        heads: int = 4,
+        num_layers: int = 2,
+        dropout: float = 0.0,
+    ):
+        super().__init__()
+        self.channels = int(channels)
+        self.heads = int(heads)
+        self.dropout = float(dropout)
+
+        self.convs = torch.nn.ModuleList()
+        for _ in range(num_layers):
+            conv = HeteroConv(
+                {
+                    edge_type: GATv2Conv(
+                        (channels, channels),
+                        channels,
+                        heads=heads,
+                        concat=False,
+                        dropout=dropout,
+                        add_self_loops=False,
+                    )
+                    for edge_type in edge_types
+                },
+                aggr="sum",
+            )
+            self.convs.append(conv)
+
+        self.norms = torch.nn.ModuleList()
+        for _ in range(num_layers):
+            norm_dict = torch.nn.ModuleDict()
+            for node_type in node_types:
+                norm_dict[node_type] = LayerNorm(channels, mode="node")
+            self.norms.append(norm_dict)
+
+    def reset_parameters(self):
+        for conv in self.convs:
+            conv.reset_parameters()
+        for norm_dict in self.norms:
+            for norm in norm_dict.values():
+                norm.reset_parameters()
+
+    def forward(
+        self,
+        x_dict: Dict[NodeType, Tensor],
+        edge_index_dict: Dict[NodeType, Tensor],
+        num_sampled_nodes_dict: Optional[Dict[NodeType, List[int]]] = None,
+        num_sampled_edges_dict: Optional[Dict[EdgeType, List[int]]] = None,
+    ) -> Dict[NodeType, Tensor]:
+        for _, (conv, norm_dict) in enumerate(zip(self.convs, self.norms)):
+            x_dict = conv(x_dict, edge_index_dict)
+            x_dict = {key: norm_dict[key](x) for key, x in x_dict.items()}
+            x_dict = {key: x.relu() for key, x in x_dict.items()}
+        return x_dict