XiaoBB commited on
Commit
eb8b101
·
verified ·
1 Parent(s): a7d0fe8

Restore correct README for github_user_events

Browse files
Files changed (1) hide show
  1. README.md +63 -91
README.md CHANGED
@@ -7,133 +7,105 @@ task_categories:
7
  tags:
8
  - temporal-point-process
9
  - event-sequences
10
- - amazon-reviews
 
 
11
  - marked-temporal-point-process
12
  size_categories:
13
  - n<1K
14
- dataset_info:
15
- features:
16
- - name: seq_idx
17
- dtype: int64
18
- - name: seq_len
19
- dtype: int64
20
- - name: description
21
- dtype: string
22
- - name: metadata
23
- dtype: string
24
- - name: time_since_start
25
- list: float64
26
- - name: time_since_last_event
27
- list: float64
28
- - name: type_event
29
- list: string
30
- - name: type_text
31
- list: string
32
- splits:
33
- - name: test
34
- num_bytes: 16978233
35
- num_examples: 382
36
- download_size: 5759486
37
- dataset_size: 16978233
38
- configs:
39
- - config_name: default
40
- data_files:
41
- - split: test
42
- path: data/test-*
43
  ---
44
 
45
- # Amazon Product Review Events
46
 
47
- Curated per-user product review sequences from [Amazon Reviews 2023](https://huggingface.co/datasets/McAuley-Lab/Amazon-Reviews-2023) (McAuley Lab), designed for temporal point process (TPP) and marked temporal point process (MTPP) modeling. Each sequence captures a single user's chronologically-ordered reviews within one product category.
48
-
49
- Sequences are aggressively filtered to prevent pattern exploitation — uninformative "other" events are removed, and sequences with dominant-type or consecutive-repeat shortcuts are dropped to ensure models must perform genuine reasoning.
50
 
51
  ## Dataset Description
52
 
53
- - **Source:** [Amazon Reviews 2023](https://huggingface.co/datasets/McAuley-Lab/Amazon-Reviews-2023) (McAuley Lab, HuggingFace)
54
- - **Categories:** Electronics, Books, Home & Kitchen, Beauty & Personal Care
55
- - **Grouping:** Events grouped by user within a single product category
56
- - **Sequences:** 286
57
- - **Sequence length:** 80100 events per sequence (mean: 88.9)
58
- - **Event types:** 54 sub-categories (no "other")
59
- - **Time unit:** days
60
 
61
  ## Schema
62
 
63
- Each record is a dictionary with 10 fields:
64
 
65
  | Field | Type | Description |
66
  |---|---|---|
67
  | `seq_idx` | int | Sequence index |
68
  | `seq_len` | int | Number of events in the sequence |
69
- | `type_category` | str | Parent product category (e.g., `"Electronics"`) |
70
- | `span_weeks` | float | Total time span of the sequence (weeks) |
71
- | `description` | str | Category, user activity window, and review period |
72
- | `metadata` | str (JSON) | `user_id`, `parent_category`, `num_reviews`, `num_sub_categories`, `date_range_start`, `date_range_end`, `span_weeks`, `time_unit` |
73
- | `time_since_start` | list[float] | Time since the first event (in days) |
74
- | `time_since_last_event` | list[float] | Time since the previous event (in days) |
75
- | `type_event` | list[str] | Product sub-category slug (see below) |
76
  | `type_text` | list[str] | Natural language description of each event |
77
 
78
- ## Event Types (54 sub-categories)
79
-
80
- Event types are the 2nd-level product sub-categories, normalized to lowercase slugs. Rare sub-categories are mapped to `"other"` during initial curation, and all `"other"` events are then stripped from the final sequences. Examples:
81
 
82
- | Category | Example Sub-categories |
83
  |---|---|
84
- | Electronics | `computers_accessories`, `camera_photo`, `television_video`, `headphones_earbuds_accessories`, `home_audio` |
85
- | Books | `literature_fiction`, `mystery_thriller_suspense`, `children_s_books`, `teen_young_adult`, `romance` |
86
- | Home & Kitchen | `kitchen_dining`, `home_d_cor_products`, `bedding`, `storage_organization`, `furniture` |
87
- | Beauty & Personal Care | `hair_care`, `skin_care`, `foot_hand_nail_care`, `makeup`, `tools_accessories` |
 
 
 
 
88
 
89
  ## Curation Filters
90
 
91
- Sequences are selected to represent moderately prolific reviewers with diverse, non-trivial sub-category distributions:
92
 
93
  | Filter | Value | Description |
94
  |---|---|---|
95
- | `min-events` | 80 | Min reviews per user sequence |
96
- | `max-events` | 100 | Max reviews per user sequence |
97
- | `min-types` | 3 | At least 3 distinct sub-category types |
98
- | `min-span` | 3 months | Exclude sequences spanning less than 3 months |
99
- | `max-span` | 60 months | Exclude sequences spanning 60+ months |
100
- | `max-sub-categories` | 15 | Top 15 sub-categories kept per parent category; rest mapped to `"other"` |
101
- | `min-subcat-count` | 50 | Sub-categories with fewer than 50 products mapped to `"other"` |
102
-
103
- ### Anti-Exploitation Filters
104
-
105
- These filters are applied after initial curation to prevent models from exploiting simple statistical shortcuts:
106
-
107
- | Filter | Value | Description |
 
 
 
 
 
108
  |---|---|---|
109
- | Remove "other" events | | All events with `type_event == "other"` are stripped; `time_since_last_event` is recomputed |
110
- | Re-check min-events/min-types | 80 / 3 | Sequences re-validated after "other" removal |
111
- | `max-dominant-ratio` | 0.35 | Drop sequences where any single type exceeds 35% of events |
112
- | `max-repeat-ratio` | 0.30 | Drop sequences where consecutive same-type rate exceeds 30% |
113
-
114
- **Filtering pipeline:** 2,537 → remove "other" events → re-check length (−585) and type diversity (−11) → dominant ratio (−1,550) → repeat ratio (−105) → **286 sequences**.
115
 
116
  ## Example
117
 
118
  ```json
119
  {
120
  "seq_idx": 0,
121
- "seq_len": 98,
122
- "type_category": "Electronics",
123
- "span_weeks": 61.33,
124
- "description": "Amazon Electronics review timeline for a user spanning Feb 2022 to Apr 2023. This sequence tracks the user's product review activity within the Electronics category on Amazon.",
125
- "metadata": "{\"user_id\": \"AHJKYQVJ...\", \"parent_category\": \"Electronics\", \"num_reviews\": 100, \"num_sub_categories\": 12, \"date_range_start\": \"2022-02-17T08:05:52.291000+00:00\", \"date_range_end\": \"2023-04-22T15:21:09.246000+00:00\", \"span_weeks\": 61.33, \"time_unit\": \"weeks\"}",
126
- "time_since_start": [0.0, 29.24, 31.50, ...],
127
- "time_since_last_event": [0.0, 29.24, 2.26, ...],
128
- "type_event": ["camera_photo", "portable_audio_video", "video_projectors", ...],
129
- "type_text": ["Product: \"Selfie Ring Light with Tripod Stand...\". 5/5 stars...", ...]
130
  }
131
  ```
132
 
133
  ## Intended Use
134
 
135
  - Training and evaluating temporal point process models
136
- - Studying consumer purchasing patterns across product sub-categories
137
  - Benchmarking next-event prediction and event forecasting
138
  - Modeling marked temporal point processes with rich text marks
139
 
@@ -142,11 +114,11 @@ These filters are applied after initial curation to prevent models from exploiti
142
  If you use this dataset, please cite:
143
 
144
  ```bibtex
145
- @dataset{amazon_review_events_2024,
146
- title={Amazon Product Review Events},
147
  author={XiaoBB},
148
  year={2024},
149
- url={https://huggingface.co/datasets/XiaoBB/amazon_review_events},
150
- note={Curated from Amazon Reviews 2023 (McAuley Lab)}
151
  }
152
  ```
 
7
  tags:
8
  - temporal-point-process
9
  - event-sequences
10
+ - github
11
+ - software-engineering
12
+ - developer-workflows
13
  - marked-temporal-point-process
14
  size_categories:
15
  - n<1K
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ---
17
 
18
+ # GitHub User Event Streams
19
 
20
+ Curated event sequences from individual GitHub developers, designed for temporal point process (TPP) and marked temporal point process (MTPP) modeling. Each sequence captures a single developer's activity across multiple repositories over a one-week window.
 
 
21
 
22
  ## Dataset Description
23
 
24
+ - **Source:** [GH Archive](https://www.gharchive.org/) raw JSON dumps
25
+ - **Time window:** June 1 - 7, 2024
26
+ - **Grouping:** Events grouped by user (actor)
27
+ - **Sequences:** ~382
28
+ - **Sequence length:** 80-100 events per sequence
29
+ - **Time unit:** hours
30
+ - **Language:** English only
31
 
32
  ## Schema
33
 
34
+ Each record is a dictionary with 8 fields:
35
 
36
  | Field | Type | Description |
37
  |---|---|---|
38
  | `seq_idx` | int | Sequence index |
39
  | `seq_len` | int | Number of events in the sequence |
40
+ | `description` | str | User name, active repos (with descriptions), and event window |
41
+ | `metadata` | str (JSON) | `actor_login`, `num_repos`, `top_repos`, `time_unit` |
42
+ | `time_since_start` | list[float] | Time since the first event (in `time_unit`, default hours) |
43
+ | `time_since_last_event` | list[float] | Time since the previous event (in `time_unit`, default hours) |
44
+ | `type_event` | list[str] | Event type labels (see below) |
 
 
45
  | `type_text` | list[str] | Natural language description of each event |
46
 
47
+ ## Event Types (8 categories)
 
 
48
 
49
+ | Label | Description |
50
  |---|---|
51
+ | `issue_opened` | New issue filed |
52
+ | `issue_closed` | Issue resolved/closed |
53
+ | `pr_opened` | Pull request opened |
54
+ | `pr_merged` | Pull request merged |
55
+ | `push` | Code pushed (with commit messages) |
56
+ | `release` | Release published |
57
+ | `pr_reviewed` | PR approved or changes requested |
58
+ | `comment` | Comment on issue, PR, or review |
59
 
60
  ## Curation Filters
61
 
62
+ Sequences are selected to represent moderately active developers working across a focused set of repositories:
63
 
64
  | Filter | Value | Description |
65
  |---|---|---|
66
+ | `min-raw-events` | 50 | Min kept-type events in archive (pre-classification) |
67
+ | `max-raw-events` | 300 | Max kept-type events in archive (pre-classification) |
68
+ | `min-events` | 80 | Min classified events per sequence |
69
+ | `max-events` | 100 | Max classified events (skip, not truncate) |
70
+ | `min-unique-types` | 5 | At least 5 distinct event types |
71
+ | `min-repos` | 2 | Active in at least 2 repos |
72
+ | `max-repos` | 5 | Active in at most 5 repos |
73
+ | `min-avg-text-len` | 150 | Min average text length per event |
74
+ | `max-type-fraction` | 0.5 | No single event type >50% of events |
75
+ | `require-english` | true | All event texts must be in English (non-Latin script detection) |
76
+
77
+ Additional processing:
78
+ - Bot users are excluded (detected by name patterns like `[bot]`, `dependabot`, etc.)
79
+ - Consecutive duplicate events (same type + text) are deduplicated
80
+
81
+ ## Key Difference from Repository Events
82
+
83
+ | | User Events | Repo Events |
84
  |---|---|---|
85
+ | Grouping | By developer | By repository |
86
+ | Cross-repo | Yes (2-5 repos) | No (single repo) |
87
+ | Text perspective | Mentions repository name | Mentions actor name |
88
+ | Use case | Developer workflow modeling | Project activity modeling |
 
 
89
 
90
  ## Example
91
 
92
  ```json
93
  {
94
  "seq_idx": 0,
95
+ "seq_len": 90,
96
+ "description": "GitHub user alice: active in org/repo-a (A web framework for Rust), org/repo-b Event window: June 02 - 07, 2024.",
97
+ "metadata": "{\"actor_login\": \"alice\", \"num_repos\": 2, \"top_repos\": [\"org/repo-a\", \"org/repo-b\"], \"time_unit\": \"hours\"}",
98
+ "time_since_start": [0.0, 0.004, ...],
99
+ "time_since_last_event": [0.0, 0.004, ...],
100
+ "type_event": ["pr_reviewed", "pr_merged", "push", ...],
101
+ "type_text": ["PR approved in org/repo-a: Add new feature...", ...]
 
 
102
  }
103
  ```
104
 
105
  ## Intended Use
106
 
107
  - Training and evaluating temporal point process models
108
+ - Studying individual developer workflow patterns across repos
109
  - Benchmarking next-event prediction and event forecasting
110
  - Modeling marked temporal point processes with rich text marks
111
 
 
114
  If you use this dataset, please cite:
115
 
116
  ```bibtex
117
+ @dataset{github_user_events_2024,
118
+ title={GitHub User Event Streams},
119
  author={XiaoBB},
120
  year={2024},
121
+ url={https://huggingface.co/datasets/XiaoBB/github_user_events},
122
+ note={Curated from GH Archive, June 2024}
123
  }
124
  ```