rel-stack: YAML manifests + descriptions + schema card

rel-stack/README.md

@@ -0,0 +1,89 @@
+---
+tags:
+- relbench
+- relational-deep-learning
+pretty_name: rel-stack
+---
+
+# rel-stack
+
+Stack Exchange Q&A: users, posts, comments, votes, badges, and post links.
+
+## Schema
+
+```mermaid
+erDiagram
+    badges {
+        key Id PK
+        key UserId FK
+        datetime Date
+    }
+    votes {
+        key Id PK
+        key PostId FK
+        key UserId FK
+        datetime CreationDate
+    }
+    users {
+        key Id PK
+        datetime CreationDate
+    }
+    comments {
+        key Id PK
+        key UserId FK
+        key PostId FK
+        datetime CreationDate
+    }
+    posts {
+        key Id PK
+        key OwnerUserId FK
+        key ParentId FK
+        datetime CreationDate
+    }
+    postLinks {
+        key Id PK
+        key PostId FK
+        key RelatedPostId FK
+        datetime CreationDate
+    }
+    postHistory {
+        key Id PK
+        key PostId FK
+        key UserId FK
+        datetime CreationDate
+    }
+    badges }o--|| users : UserId
+    votes }o--|| posts : PostId
+    votes }o--|| users : UserId
+    comments }o--|| users : UserId
+    comments }o--|| posts : PostId
+    posts }o--|| users : OwnerUserId
+    posts }o--|| posts : ParentId
+    postLinks }o--|| posts : PostId
+    postLinks }o--|| posts : RelatedPostId
+    postHistory }o--|| posts : PostId
+    postHistory }o--|| users : UserId
+```
+
+Splits: validation `2020-10-01`, test `2021-01-01` (rows up to a split's timestamp are the inputs for that split).
+
+## Tasks
+
+| task | kind | type | description |
+|---|---|---|---|
+| `badges-class` | autocomplete | multiclass_classification | Predict the `Class` column of the `badges` table. |
+| `post-post-related` | forecast | link_prediction | Predict a list of existing posts that users will link a given post to in the next two years. |
+| `post-votes` | forecast | regression | Predict the number of upvotes that an existing question will receive in the next 2 years. |
+| `user-badge` | forecast | binary_classification | Predict if each user will receive in a new badge the next 2 years. |
+| `user-engagement` | forecast | binary_classification | Predict if a user will make any votes/posts/comments in the next 2 years. |
+| `user-post-comment` | forecast | link_prediction | Predict a list of existing posts that a user will comment in the next two years. |
+
+## Loading
+
+```python
+import relbench
+ds = relbench.load_dataset("rel-stack")
+task = relbench.load_task("rel-stack", "<task>")
+```
+
+Manifest layout (`manifest.yaml` + plain parquet); see the RelBench [CONTRIBUTING guide](https://github.com/snap-stanford/relbench/blob/main/CONTRIBUTING.md).

rel-stack/manifest.json

@@ -1,60 +0,0 @@
-{
-  "name": "rel-stack",
-  "manifest_version": 1,
-  "val_timestamp": "2020-10-01",
-  "test_timestamp": "2021-01-01",
-  "tables": {
-    "badges": {
-      "pkey": "Id",
-      "time_col": "Date",
-      "fkeys": {
-        "UserId": "users"
-      }
-    },
-    "votes": {
-      "pkey": "Id",
-      "time_col": "CreationDate",
-      "fkeys": {
-        "PostId": "posts",
-        "UserId": "users"
-      }
-    },
-    "users": {
-      "pkey": "Id",
-      "time_col": "CreationDate",
-      "fkeys": {}
-    },
-    "comments": {
-      "pkey": "Id",
-      "time_col": "CreationDate",
-      "fkeys": {
-        "UserId": "users",
-        "PostId": "posts"
-      }
-    },
-    "posts": {
-      "pkey": "Id",
-      "time_col": "CreationDate",
-      "fkeys": {
-        "OwnerUserId": "users",
-        "ParentId": "posts"
-      }
-    },
-    "postLinks": {
-      "pkey": "Id",
-      "time_col": "CreationDate",
-      "fkeys": {
-        "PostId": "posts",
-        "RelatedPostId": "posts"
-      }
-    },
-    "postHistory": {
-      "pkey": "Id",
-      "time_col": "CreationDate",
-      "fkeys": {
-        "PostId": "posts",
-        "UserId": "users"
-      }
-    }
-  }
-}

rel-stack/manifest.yaml

@@ -0,0 +1,45 @@
+name: rel-stack
+manifest_version: 1
+description: 'Stack Exchange Q&A: users, posts, comments, votes, badges, and post links.'
+val_timestamp: '2020-10-01'
+test_timestamp: '2021-01-01'
+tables:
+  badges:
+    pkey: Id
+    time_col: Date
+    fkeys:
+      UserId: users
+  votes:
+    pkey: Id
+    time_col: CreationDate
+    fkeys:
+      PostId: posts
+      UserId: users
+  users:
+    pkey: Id
+    time_col: CreationDate
+    fkeys: {}
+  comments:
+    pkey: Id
+    time_col: CreationDate
+    fkeys:
+      UserId: users
+      PostId: posts
+  posts:
+    pkey: Id
+    time_col: CreationDate
+    fkeys:
+      OwnerUserId: users
+      ParentId: posts
+  postLinks:
+    pkey: Id
+    time_col: CreationDate
+    fkeys:
+      PostId: posts
+      RelatedPostId: posts
+  postHistory:
+    pkey: Id
+    time_col: CreationDate
+    fkeys:
+      PostId: posts
+      UserId: users

rel-stack/tasks/badges-class/manifest.json

@@ -1,19 +0,0 @@
-{
-  "name": "badges-class",
-  "kind": "autocomplete",
-  "task_type": "multiclass_classification",
-  "entity_table": "badges",
-  "target_col": "Class",
-  "metrics": [],
-  "remove_columns": [
-    [
-      "badges",
-      "TagBased"
-    ],
-    [
-      "badges",
-      "Name"
-    ]
-  ],
-  "manifest_version": 1
-}

rel-stack/tasks/badges-class/manifest.yaml

@@ -0,0 +1,12 @@
+name: badges-class
+kind: autocomplete
+task_type: multiclass_classification
+description: Predict the `Class` column of the `badges` table.
+entity_table: badges
+target_col: Class
+remove_columns:
+- - badges
+  - TagBased
+- - badges
+  - Name
+manifest_version: 1

rel-stack/tasks/post-post-related/manifest.json

@@ -1,20 +0,0 @@
-{
-  "name": "post-post-related",
-  "kind": "forecast",
-  "task_type": "link_prediction",
-  "target_col": "postLinksIdList",
-  "time_col": "timestamp",
-  "src_entity_table": "posts",
-  "src_entity_col": "PostId",
-  "dst_entity_table": "posts",
-  "dst_entity_col": "postLinksIdList",
-  "eval_k": 100,
-  "timedelta": "91 days",
-  "metrics": [
-    "link_prediction_precision",
-    "link_prediction_recall",
-    "link_prediction_map"
-  ],
-  "sql": "\n                SELECT\n                    t.timestamp,\n                    pl.PostId as PostId,\n                    LIST(DISTINCT pl.RelatedPostId) AS postLinksIdList\n                FROM\n                    timestamps t\n                LEFT JOIN\n                    postLinks pl\n                ON\n                    pl.CreationDate > t.timestamp AND\n                    pl.CreationDate <= t.timestamp + INTERVAL '{timedelta}'\n                LEFT JOIN\n                    posts p1\n                ON\n                    pl.PostId = p1.Id\n                LEFT JOIN\n                    posts p2\n                ON\n                    pl.RelatedPostId = p2.Id\n                WHERE\n                    pl.PostId IS NOT NULL AND\n                    pl.RelatedPostId IS NOT NULL AND\n                    p1.CreationDate <= t.timestamp AND\n                    p2.CreationDate <= t.timestamp\n                GROUP BY\n                    t.timestamp,\n                    pl.PostId;\n            ",
-  "manifest_version": 1
-}

rel-stack/tasks/post-post-related/manifest.yaml

@@ -0,0 +1,14 @@
+name: post-post-related
+kind: forecast
+task_type: link_prediction
+description: Predict a list of existing posts that users will link a given post to in the next two years.
+target_col: postLinksIdList
+time_col: timestamp
+src_entity_table: posts
+src_entity_col: PostId
+dst_entity_table: posts
+dst_entity_col: postLinksIdList
+eval_k: 100
+timedelta: 91 days
+sql: "\n                SELECT\n                    t.timestamp,\n                    pl.PostId as PostId,\n                    LIST(DISTINCT pl.RelatedPostId) AS postLinksIdList\n                FROM\n                    timestamps t\n                LEFT JOIN\n                    postLinks pl\n                ON\n                    pl.CreationDate > t.timestamp AND\n                    pl.CreationDate <= t.timestamp + INTERVAL '{timedelta}'\n                LEFT JOIN\n                    posts p1\n                ON\n                    pl.PostId = p1.Id\n                LEFT JOIN\n                    posts p2\n                ON\n                    pl.RelatedPostId = p2.Id\n                WHERE\n                    pl.PostId IS NOT NULL AND\n                    pl.RelatedPostId IS NOT NULL AND\n                    p1.CreationDate <= t.timestamp AND\n                    p2.CreationDate <= t.timestamp\n                GROUP BY\n                    t.timestamp,\n                    pl.PostId;\n            "
+manifest_version: 1

rel-stack/tasks/post-votes/manifest.json

@@ -1,17 +0,0 @@
-{
-  "name": "post-votes",
-  "kind": "forecast",
-  "task_type": "regression",
-  "entity_table": "posts",
-  "entity_col": "PostId",
-  "target_col": "popularity",
-  "time_col": "timestamp",
-  "timedelta": "91 days",
-  "metrics": [
-    "r2",
-    "mae",
-    "rmse"
-  ],
-  "sql": "\n            SELECT\n                t.timestamp,\n                p.id AS PostId,\n                COUNT(distinct v.id) AS popularity\n            FROM\n                timestamps t\n            LEFT JOIN\n                posts p\n            ON\n                p.CreationDate <= t.timestamp AND\n                p.owneruserid != -1 AND\n                p.owneruserid is not null AND\n                p.PostTypeId = 1\n            LEFT JOIN\n                votes v\n            ON\n                p.id = v.PostId AND\n                v.CreationDate > t.timestamp AND\n                v.CreationDate <= t.timestamp + INTERVAL '{timedelta}' AND\n                v.votetypeid = 2\n            GROUP BY\n                t.timestamp,\n                p.id\n            ;\n\n            ",
-  "manifest_version": 1
-}

rel-stack/tasks/post-votes/manifest.yaml

@@ -0,0 +1,11 @@
+name: post-votes
+kind: forecast
+task_type: regression
+description: Predict the number of upvotes that an existing question will receive in the next 2 years.
+entity_table: posts
+entity_col: PostId
+target_col: popularity
+time_col: timestamp
+timedelta: 91 days
+sql: "\n            SELECT\n                t.timestamp,\n                p.id AS PostId,\n                COUNT(distinct v.id) AS popularity\n            FROM\n                timestamps t\n            LEFT JOIN\n                posts p\n            ON\n                p.CreationDate <= t.timestamp AND\n                p.owneruserid != -1 AND\n                p.owneruserid is not null AND\n                p.PostTypeId = 1\n            LEFT JOIN\n                votes v\n            ON\n                p.id = v.PostId AND\n                v.CreationDate > t.timestamp AND\n                v.CreationDate <= t.timestamp + INTERVAL '{timedelta}' AND\n                v.votetypeid = 2\n            GROUP BY\n                t.timestamp,\n                p.id\n            ;\n\n            "
+manifest_version: 1

rel-stack/tasks/user-badge/manifest.json

@@ -1,18 +0,0 @@
-{
-  "name": "user-badge",
-  "kind": "forecast",
-  "task_type": "binary_classification",
-  "entity_table": "users",
-  "entity_col": "UserId",
-  "target_col": "WillGetBadge",
-  "time_col": "timestamp",
-  "timedelta": "91 days",
-  "metrics": [
-    "average_precision",
-    "accuracy",
-    "f1",
-    "roc_auc"
-  ],
-  "sql": "\n            SELECT\n                timestamp,\n                CAST(UserId AS BIGINT) AS UserId,\n                WillGetBadge\n            FROM (\n            SELECT\n                t.timestamp,\n                u.Id as UserId,\n            CASE WHEN\n                COUNT(b.Id) >= 1 THEN 1 ELSE 0 END AS WillGetBadge\n            FROM\n                timestamps t\n            LEFT JOIN\n                users u\n            ON\n                u.CreationDate <= t.timestamp\n            LEFT JOIN\n                badges b\n            ON\n                u.Id = b.UserID\n                AND b.Date > t.timestamp\n                AND b.Date <= t.timestamp + INTERVAL '{timedelta}'\n            GROUP BY\n                t.timestamp,\n                u.Id\n            )\n            WHERE UserId IS NOT NULL\n            ",
-  "manifest_version": 1
-}

rel-stack/tasks/user-badge/manifest.yaml

@@ -0,0 +1,11 @@
+name: user-badge
+kind: forecast
+task_type: binary_classification
+description: Predict if each user will receive in a new badge the next 2 years.
+entity_table: users
+entity_col: UserId
+target_col: WillGetBadge
+time_col: timestamp
+timedelta: 91 days
+sql: "\n            SELECT\n                timestamp,\n                CAST(UserId AS BIGINT) AS UserId,\n                WillGetBadge\n            FROM (\n            SELECT\n                t.timestamp,\n                u.Id as UserId,\n            CASE WHEN\n                COUNT(b.Id) >= 1 THEN 1 ELSE 0 END AS WillGetBadge\n            FROM\n                timestamps t\n            LEFT JOIN\n                users u\n            ON\n                u.CreationDate <= t.timestamp\n            LEFT JOIN\n                badges b\n            ON\n                u.Id = b.UserID\n                AND b.Date > t.timestamp\n                AND b.Date <= t.timestamp + INTERVAL '{timedelta}'\n            GROUP BY\n                t.timestamp,\n                u.Id\n            )\n            WHERE UserId IS NOT NULL\n            "
+manifest_version: 1

rel-stack/tasks/user-engagement/manifest.json

@@ -1,18 +0,0 @@
-{
-  "name": "user-engagement",
-  "kind": "forecast",
-  "task_type": "binary_classification",
-  "entity_table": "users",
-  "entity_col": "OwnerUserId",
-  "target_col": "contribution",
-  "time_col": "timestamp",
-  "timedelta": "91 days",
-  "metrics": [
-    "average_precision",
-    "accuracy",
-    "f1",
-    "roc_auc"
-  ],
-  "sql": "\n            WITH\n            ALL_ENGAGEMENT AS (\n                SELECT\n                    p.id,\n                    p.owneruserid as userid,\n                    p.creationdate\n                FROM\n                    posts p\n                UNION\n                SELECT\n                    v.id,\n                    v.userid,\n                    v.creationdate\n                FROM\n                    votes v\n                UNION\n                SELECT\n                    c.id,\n                    c.userid,\n                    c.creationdate\n                FROM\n                    comments c\n            ),\n\n            ACTIVE_USERS AS (\n                 SELECT\n                    t.timestamp,\n                    u.id,\n                    count(distinct a.id) as n_engagement\n                FROM timestamps t\n                CROSS JOIN users u\n                LEFT JOIN all_engagement a\n                ON u.id = a.UserId\n                    and a.CreationDate <= t.timestamp\n                WHERE u.id != -1\n                GROUP BY t.timestamp, u.id\n             )\n                SELECT\n                    u.timestamp,\n                    u.id as OwnerUserId,\n                    IF(count(distinct a.id) >= 1, 1, 0) as contribution\n                FROM\n                    active_users u\n                LEFT JOIN\n                    all_engagement a\n                ON\n                    u.id = a.UserId AND\n                    a.CreationDate > u.timestamp AND\n                    a.CreationDate <= u.timestamp + INTERVAL '{timedelta}'\n                where\n                    u.n_engagement >= 1\n                GROUP BY\n                    u.timestamp, u.id\n            ;\n\n            ",
-  "manifest_version": 1
-}

rel-stack/tasks/user-engagement/manifest.yaml

@@ -0,0 +1,11 @@
+name: user-engagement
+kind: forecast
+task_type: binary_classification
+description: Predict if a user will make any votes/posts/comments in the next 2 years.
+entity_table: users
+entity_col: OwnerUserId
+target_col: contribution
+time_col: timestamp
+timedelta: 91 days
+sql: "\n            WITH\n            ALL_ENGAGEMENT AS (\n                SELECT\n                    p.id,\n                    p.owneruserid as userid,\n                    p.creationdate\n                FROM\n                    posts p\n                UNION\n                SELECT\n                    v.id,\n                    v.userid,\n                    v.creationdate\n                FROM\n                    votes v\n                UNION\n                SELECT\n                    c.id,\n                    c.userid,\n                    c.creationdate\n                FROM\n                    comments c\n            ),\n\n            ACTIVE_USERS AS (\n                 SELECT\n                    t.timestamp,\n                    u.id,\n                    count(distinct a.id) as n_engagement\n                FROM timestamps t\n                CROSS JOIN users u\n                LEFT JOIN all_engagement a\n                ON u.id = a.UserId\n                    and a.CreationDate <= t.timestamp\n                WHERE u.id != -1\n                GROUP BY t.timestamp, u.id\n             )\n                SELECT\n                    u.timestamp,\n                    u.id as OwnerUserId,\n                    IF(count(distinct a.id) >= 1, 1, 0) as contribution\n                FROM\n                    active_users u\n                LEFT JOIN\n                    all_engagement a\n                ON\n                    u.id = a.UserId AND\n                    a.CreationDate > u.timestamp AND\n                    a.CreationDate <= u.timestamp + INTERVAL '{timedelta}'\n                where\n                    u.n_engagement >= 1\n                GROUP BY\n                    u.timestamp, u.id\n            ;\n\n            "
+manifest_version: 1

rel-stack/tasks/user-post-comment/manifest.json

@@ -1,20 +0,0 @@
-{
-  "name": "user-post-comment",
-  "kind": "forecast",
-  "task_type": "link_prediction",
-  "target_col": "PostId",
-  "time_col": "timestamp",
-  "src_entity_table": "users",
-  "src_entity_col": "UserId",
-  "dst_entity_table": "posts",
-  "dst_entity_col": "PostId",
-  "eval_k": 100,
-  "timedelta": "91 days",
-  "metrics": [
-    "link_prediction_precision",
-    "link_prediction_recall",
-    "link_prediction_map"
-  ],
-  "sql": "\n            SELECT\n                t.timestamp,\n                c.UserId as UserId,\n                LIST(DISTINCT p.id) AS PostId\n            FROM\n                timestamps t\n            LEFT JOIN\n                posts p\n            ON\n                p.CreationDate <= t.timestamp\n            LEFT JOIN\n                comments c\n            ON\n                p.id = c.PostId AND\n                c.CreationDate > t.timestamp AND\n                c.CreationDate <= t.timestamp + INTERVAL '{timedelta}'\n            WHERE\n                c.UserId is not null AND\n                p.owneruserid != -1 AND\n                p.owneruserid is not null\n            GROUP BY\n                t.timestamp,\n                c.UserId\n            ",
-  "manifest_version": 1
-}

rel-stack/tasks/user-post-comment/manifest.yaml

@@ -0,0 +1,14 @@
+name: user-post-comment
+kind: forecast
+task_type: link_prediction
+description: Predict a list of existing posts that a user will comment in the next two years.
+target_col: PostId
+time_col: timestamp
+src_entity_table: users
+src_entity_col: UserId
+dst_entity_table: posts
+dst_entity_col: PostId
+eval_k: 100
+timedelta: 91 days
+sql: "\n            SELECT\n                t.timestamp,\n                c.UserId as UserId,\n                LIST(DISTINCT p.id) AS PostId\n            FROM\n                timestamps t\n            LEFT JOIN\n                posts p\n            ON\n                p.CreationDate <= t.timestamp\n            LEFT JOIN\n                comments c\n            ON\n                p.id = c.PostId AND\n                c.CreationDate > t.timestamp AND\n                c.CreationDate <= t.timestamp + INTERVAL '{timedelta}'\n            WHERE\n                c.UserId is not null AND\n                p.owneruserid != -1 AND\n                p.owneruserid is not null\n            GROUP BY\n                t.timestamp,\n                c.UserId\n            "
+manifest_version: 1