Docs: update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,57 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# RDB2G-Bench
|
| 2 |
+
|
| 3 |
+
[](https://opensource.org/licenses/MIT)
|
| 4 |
+
[](https://github.com/chlehdwon/RDB2G-Bench)
|
| 5 |
+
|
| 6 |
+
|
| 7 |
+
This is an offical dataset of the paper **RDB2G-Bench: A Comprehensive Benchmark for Automatic Graph Modeling of Relational Databases.**
|
| 8 |
+
|
| 9 |
+
RDB2G-Bench is a toolkit for benchmarking graph-based analysis and prediction tasks by converting relational database data into graphs.
|
| 10 |
+
|
| 11 |
+
Our code is available at [GitHub](https://github.com/chlehdwon/RDB2G-Bench).
|
| 12 |
+
|
| 13 |
+
## Overview
|
| 14 |
+
|
| 15 |
+
RDB2G-Bench provides comprehensive performance evaluation data for graph neural network models applied to relational database tasks. The dataset contains extensive experiments across multiple graph configurations and architectures.
|
| 16 |
+
|
| 17 |
+
## Dataset Summary
|
| 18 |
+
|
| 19 |
+
Each CSV file contains experimental results with the following columns:
|
| 20 |
+
|
| 21 |
+
| Column | Description |
|
| 22 |
+
|--------|-------------|
|
| 23 |
+
| `idx` | Unique identifier for each experimental configuration |
|
| 24 |
+
| `graph` | Binary-encoded string representing the graph structure configuration (e.g., "graph_00000000000010") |
|
| 25 |
+
| `train_metric` | Performance metric on the training set (e.g., AUC for classification, MSE for regression, MAP for recommendation) |
|
| 26 |
+
| `valid_metric` | Performance metric on the validation set |
|
| 27 |
+
| `test_metric` | Performance metric on the test set |
|
| 28 |
+
| `params` | Total number of trainable parameters in the model |
|
| 29 |
+
| `train_time` | Training time in seconds |
|
| 30 |
+
| `valid_time` | Validation time in seconds |
|
| 31 |
+
| `test_time` | Testing time in seconds |
|
| 32 |
+
| `dataset` | Name of the RDB dataset used (e.g., "rel-avito", "rel-f1") |
|
| 33 |
+
| `task` | Name of the prediction task (e.g., "ad-ctr", "user-clicks") |
|
| 34 |
+
| `seed` | Random seed for reproducibility |
|
| 35 |
+
|
| 36 |
+
### Graph Column Specification
|
| 37 |
+
|
| 38 |
+
The `graph` column uses binary encoding to represent different edge configurations in the graph structure. Each bit position corresponds to a specific edge type as defined in `edge_info.json`:
|
| 39 |
+
|
| 40 |
+
- **1**: Edge is connected
|
| 41 |
+
- **0**: Edge is disconnected
|
| 42 |
+
|
| 43 |
+
#### Edge Types:
|
| 44 |
+
- **r2e**: Converted relationships that each row of table trasnsformed to edge.
|
| 45 |
+
- **f2p**: Standard foreign key relationships that each row trasnsformed to node.
|
| 46 |
+
|
| 47 |
+
The complete edge mapping for each dataset can be found in the `edge_info.json` file.
|
| 48 |
+
|
| 49 |
+
## Reference
|
| 50 |
+
|
| 51 |
+
The dataset construction and implementation of RDB2G-Bench based on [RelBench](https://github.com/snap-stanford/relbench) framework.
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
## License
|
| 55 |
+
|
| 56 |
+
This project is distributed under the MIT License as specified in the LICENSE file.
|
| 57 |
+
|