Tamir39 commited on
Commit
e80bac4
·
verified ·
1 Parent(s): ab6384e

update dataset card for ATE v2 schema

Browse files
Files changed (1) hide show
  1. README.md +56 -50
README.md CHANGED
@@ -2,7 +2,6 @@
2
  license: cc-by-sa-4.0
3
  task_categories:
4
  - token-classification
5
- - text-generation
6
  language:
7
  - vi
8
  size_categories:
@@ -10,86 +9,93 @@ size_categories:
10
  tags:
11
  - vietnamese
12
  - reviews
 
13
  - aspect-based-sentiment
14
- - cause-extraction
15
  - e-commerce
16
- pretty_name: CausaSent
 
17
  ---
18
 
19
- # CausaSent — Vietnamese Review Causal Sentiment Dataset
20
 
21
- Per-review tuples of `(aspect, sentiment, cause_span, action)` for Vietnamese e-commerce reviews.
22
 
23
  ## Schema
24
 
25
- Each row in `gold/{train,val,test}.json` is:
26
 
27
  ```json
28
  {
29
- "id": "string",
30
- "review": "Ship lâu nhưng đóng gói đẹp",
 
31
  "annotations": [
32
  {
33
- "aspect": "delivery",
34
- "sentiment": "negative",
35
- "cause_text": "Ship lâu",
36
- "cause_span": [0, 8],
37
- "action": "Rút ngắn thời gian giao hàng"
38
  },
39
  {
40
- "aspect": "packaging",
41
- "sentiment": "positive",
42
- "cause_text": "đóng gói đẹp",
43
- "cause_span": [15, 27],
44
- "action": "Duy trì cách đóng gói"
45
  }
46
  ]
47
  }
48
  ```
49
 
50
- Hard invariants on every annotation (validated at load time):
51
 
52
- - `review[cause_span[0]:cause_span[1]] == cause_text` (exact substring; Python codepoint indexing).
53
- - `aspect ∈ {delivery, packaging, product_quality, price, customer_service, usability, appearance}`.
54
- - `sentiment ∈ {positive, negative, neutral}`.
55
- - Within a review, no two `cause_span`s overlap.
56
- - `action` is imperative, verb-first, ≤10 Vietnamese words.
57
 
58
  ## Splits
59
 
60
  | Split | Reviews | Annotations |
61
- |-------|---------|-------------|
62
- | train | TBD | TBD |
63
- | val | TBD | TBD |
64
- | test | TBD | TBD |
 
65
 
66
- Numbers populated after `scripts/split_dataset.py` runs.
67
 
68
- ## Annotation process
69
 
70
- 1. Raw reviews collected from public Vietnamese review datasets (UIT-VSFC, ViSFD, Foody) plus a small manual export of Shopee / Google Maps reviews (ToS-safe, copy-paste only).
71
- 2. Weak-labeled with Gemini 2.5 Flash via `src/data/weak_label.py` (closed-taxonomy prompt, JSON mode, exact-substring constraint).
72
- 3. Validated by `src/data/validate.py` (drops hallucinated spans, bad aspects, duplicates, overlaps).
73
- 4. Manually refined to ≥1000 gold samples per [`docs/annotation-guide.md`](https://github.com/tamir39/causa-sent/blob/develop/docs/annotation-guide.md) via the Gradio review UI in `src/tools/review_ui.py`.
74
- 5. 80/10/10 splits by review id with seed 42.
 
 
 
 
75
 
76
- ## Intended use
77
 
78
- - Train aspect-sentiment + cause extraction models (e.g., PhoBERT-large two-head tagger).
79
- - Train action generation models (e.g., mT5-base) conditioned on extracted tuples.
80
- - Benchmark fine-grained ABSA + causal-rationale tasks on Vietnamese.
81
 
82
- ## License
 
83
 
84
- Released under **CC-BY-SA-4.0**. Derivative works must share-alike. Underlying public review corpora retain their original licenses; respect those when redistributing.
85
 
86
- ## Citation
87
 
88
- ```bibtex
89
- @misc{causasent2026,
90
- title = {CausaSent: Causal and Actionable Sentiment Analysis for Vietnamese Reviews},
91
- author = {Phí Vương Tường Tâm},
92
- year = {2026},
93
- howpublished = {\url{https://huggingface.co/datasets/Tamir39/causasent}}
94
- }
95
- ```
 
 
 
 
 
2
  license: cc-by-sa-4.0
3
  task_categories:
4
  - token-classification
 
5
  language:
6
  - vi
7
  size_categories:
 
9
  tags:
10
  - vietnamese
11
  - reviews
12
+ - aspect-term-extraction
13
  - aspect-based-sentiment
 
14
  - e-commerce
15
+ - absa
16
+ pretty_name: CausaSent ATE v2
17
  ---
18
 
19
+ # CausaSent ATE v2 — Vietnamese E-commerce Aspect Term Extraction + ABSA
20
 
21
+ Vietnamese e-commerce reviews labeled with **aspect terms (span)**, **aspect category**, and **binary sentiment** combined from a small manually-annotated gold pool (hotel + restaurant + smartphone reviews) and a larger LLM-labeled silver pool (Tiki product reviews).
22
 
23
  ## Schema
24
 
25
+ Each row in `train.json` / `val.json` / `test.json` is:
26
 
27
  ```json
28
  {
29
+ "id": "tiki-14075703",
30
+ "source": "tiki",
31
+ "review": "Hàng đóng gói không cẩn thận, hộp méo mó, rách nhiều.",
32
  "annotations": [
33
  {
34
+ "aspect_term": "Hàng",
35
+ "aspect_term_span": [0, 4],
36
+ "aspect_category": "appearance",
37
+ "sentiment": "negative"
 
38
  },
39
  {
40
+ "aspect_term": "đóng gói",
41
+ "aspect_term_span": [5, 13],
42
+ "aspect_category": "packaging",
43
+ "sentiment": "negative"
 
44
  }
45
  ]
46
  }
47
  ```
48
 
49
+ **Hard invariants:**
50
 
51
+ - `review[aspect_term_span[0]:aspect_term_span[1]] == aspect_term` byte-for-byte.
52
+ - `aspect_category` ∈ {`delivery`, `packaging`, `product_quality`, `price`, `customer_service`, `usability`, `appearance`} — closed 7-class taxonomy.
53
+ - `sentiment` ∈ {`positive`, `negative`} neutral was dropped (only 2.7% of gold, too few to train).
54
+ - `source` {`gold`, `tiki`}.
 
55
 
56
  ## Splits
57
 
58
  | Split | Reviews | Annotations |
59
+ |---|---|---|
60
+ | train | 5,647 | 8,251 |
61
+ | val | 700 | 1,033 |
62
+ | test | 719 | 1,023 |
63
+ | **total** | **7,066** | **10,307** |
64
 
65
+ Stratified 80/10/10 by dominant `(aspect_category, sentiment)` per review.
66
 
67
+ Aspect coverage in train (annotation count):
68
 
69
+ | aspect_category | count |
70
+ |---|---|
71
+ | appearance | 2,789 |
72
+ | product_quality | 2,133 |
73
+ | delivery | 982 |
74
+ | packaging | 896 |
75
+ | price | 922 |
76
+ | customer_service | 424 |
77
+ | usability | 105 |
78
 
79
+ Sentiment leans negative for `appearance` / `packaging` (Tiki complaints) and positive for `price` / `customer_service`.
80
 
81
+ ## Data sources
 
 
82
 
83
+ - **Gold (1,132 reviews, 2,205 annotations):** subset of CausaSent original manual annotations (drop `neutral`, drop `cause_span`/`action` fields). Schema converted via Claude-assisted aspect-term span extraction; 3 NFD-encoding edge cases dropped. See [Tamir39/causasent](https://huggingface.co/datasets/Tamir39/causasent) for the pre-pivot 4-tuple version.
84
+ - **Tiki silver (5,934 reviews, 8,102 annotations):** Vietnamese Tiki product reviews originally labeled with `aspect_category` + `sentiment` by an LLM (mid-term project); we added `aspect_term_span` via the same Claude pipeline. 14 records dropped on span verification.
85
 
86
+ ## Annotation pipeline
87
 
88
+ Both sources passed through the same Claude-based annotation pipeline (`scripts/annotate_aspect_terms.py` orchestrator → `scripts/SUBAGENT_PROMPT.md` per-batch worker → `scripts/verify_annotation_batch.py` byte-match check → `scripts/merge_annotation_batches.py`). 99.86% of gold and 99.83% of Tiki survived span verification.
89
 
90
+ A stratified sample of 300 gold records was independently re-validated; inter-annotator agreement ≈ 91% (judged term matches LLM's pick).
91
+
92
+ ## Intended use
93
+
94
+ Joint aspect-term extraction + aspect-category-aware sentiment classification on Vietnamese e-commerce text. Suitable for:
95
+ - Training PhoBERT/XLM-R BIO span taggers with auxiliary sentiment head.
96
+ - Comparing fine-tuned models vs. zero-shot LLM baselines on Vietnamese ATE.
97
+ - ABSA-informed action recommendation pipelines (per the paper this dataset accompanies).
98
+
99
+ ## License & ToS
100
+
101
+ Released under CC-BY-SA-4.0. The Tiki subset comes from publicly-displayed product reviews; we redistribute only the text and our derived annotations. If you use this dataset, please cite the original CausaSent project.