Lucius-Morningstar commited on
Commit
fb74aae
·
verified ·
1 Parent(s): 6ec9d53

Dataset card: full best-practices pass (source attribution, licensing/PII, citation, mailroom refs; fix dead companion link)

Browse files
Files changed (1) hide show
  1. README.md +111 -15
README.md CHANGED
@@ -1,9 +1,18 @@
1
  ---
2
  license: other
 
3
  task_categories:
4
  - text-classification
5
  language:
6
  - en
 
 
 
 
 
 
 
 
7
  tags:
8
  - legal
9
  - enron
@@ -36,12 +45,12 @@ configs:
36
 
37
  # Enron Correspondence Deduplicated (Enriched GT, Agent-Blind Default)
38
 
39
- The **deduplicated, ground-truth-enriched** companion to
40
- [`Lucius-Morningstar/enron-correspondence`](https://huggingface.co/datasets/Lucius-Morningstar/enron-correspondence):
41
- exact-duplicate bodies removed from the cleaned CMU Enron corpus (517,390
42
- rows in -> **247,523 unique-text rows out**, 269,867 duplicates dropped;
43
- first occurrence wins on maildir-path order; empty bodies never deduped against
44
- each other).
45
 
46
  ## ⚠️ Two-config layout: agents get NO answers by default
47
 
@@ -80,20 +89,24 @@ JSON. The single-file 548 MB `blind/train.jsonl` crashed the Dataset Viewer's
80
  conversion worker (`JobManagerCrashedError`); serving parquet directly removes
81
  that conversion step entirely.
82
 
 
 
 
83
  ## Ground-truth dimensions
84
 
85
  1. **doc_type / subclass** (`expected`, `expected_subclass`,
86
  `label_evidence`) — heuristic form taxonomy from the shared
87
- [`correspondence_subclasses`](https://github.com/Exios66/Enron-Evaluation-Environment)
88
  labeler: attorney_demand, demand, email, letter, meeting_request, memo, notice, press_release.
89
  2. **content_topic** (`content_topic`, `topic_evidence`) — WHAT the message
90
  body is about: an 11-key priority-scored marker taxonomy
91
- (`content_topics.py`): legal_contracts, regulatory, finance_earnings, energy_market, hr_personnel, it_systems, travel_logistics, marketing_clients, announcements, scheduling.
 
92
  3. **sentiment** (`sentiment_score` ∈ [-1, 1], `sentiment_label` ∈
93
  negative/neutral/positive, `sentiment_evidence`) — deterministic lexicon
94
  polarity over the subject + forwarded-tail-stripped body
95
- (`sentiment_scorer.py`), negation/intensifier-aware, politeness-formula
96
- controlled.
97
 
98
  All three dimensions are HEURISTIC ground truth (deterministic pure functions,
99
  human-reviewed via spot checks where noted) — not hand annotations. Honest
@@ -109,13 +122,96 @@ Per-row `split` follows the family rule `md5(filename) % 10 == 0 -> test`
109
  dedup/enrichment cannot change any surviving row's split. Coverage: train
110
  222,572 / test 24,951.
111
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
112
  ## Provenance
113
 
114
  Built by [`llm-entity-extraction`](https://github.com/Exios66/llm-entity-extraction)
115
  `scripts/datasets/publish_enron_correspondence_dedup.py` (KANBAN-079,
116
  2026-08-23T18:52:37+00:00) from the sha256-verified full-corpus export (LFS
117
- `0554a5973935…`). Labelers: Enron-Evaluation-Environment `scripts/`
118
- (`correspondence_subclasses.py`, `content_topics.py`,
119
- `sentiment_scorer.py`). Source: CMU Enron Email Dataset (cleaned maildir);
120
- dedup rule `scripts/dedupe.py::body_hash`. Research-use license treat
121
- personally identifying content accordingly.
 
 
 
 
 
 
 
1
  ---
2
  license: other
3
+ license_name: research-only-enron-corpus
4
  task_categories:
5
  - text-classification
6
  language:
7
  - en
8
+ language_creators:
9
+ - found
10
+ multilinguality:
11
+ - monolingual
12
+ annotations_creators:
13
+ - machine-generated
14
+ source_datasets:
15
+ - extended
16
  tags:
17
  - legal
18
  - enron
 
45
 
46
  # Enron Correspondence Deduplicated (Enriched GT, Agent-Blind Default)
47
 
48
+ The **deduplicated, ground-truth-enriched** Enron correspondence benchmark:
49
+ exact-duplicate bodies removed from the cleaned CMU Enron corpus (**517,390
50
+ rows in 247,523 unique-text rows out**, 269,867 duplicates dropped; first
51
+ occurrence wins on maildir-path order; empty bodies never deduped against
52
+ each other). This dataset is the core evaluation corpus for the
53
+ [LLM Mailroom](https://github.com/Exios66/llm-mailroom) agent-sorting stack.
54
 
55
  ## ⚠️ Two-config layout: agents get NO answers by default
56
 
 
89
  conversion worker (`JobManagerCrashedError`); serving parquet directly removes
90
  that conversion step entirely.
91
 
92
+ A machine-readable build manifest (`manifest.txt`) records schema version,
93
+ row counts, and the dedup/enrichment provenance chain.
94
+
95
  ## Ground-truth dimensions
96
 
97
  1. **doc_type / subclass** (`expected`, `expected_subclass`,
98
  `label_evidence`) — heuristic form taxonomy from the shared
99
+ [`correspondence_subclasses`](https://github.com/Exios66/Enron-Evaluation-Environment/blob/main/scripts/correspondence_subclasses.py)
100
  labeler: attorney_demand, demand, email, letter, meeting_request, memo, notice, press_release.
101
  2. **content_topic** (`content_topic`, `topic_evidence`) — WHAT the message
102
  body is about: an 11-key priority-scored marker taxonomy
103
+ ([`content_topics.py`](https://github.com/Exios66/Enron-Evaluation-Environment/blob/main/scripts/content_topics.py)):
104
+ legal_contracts, regulatory, finance_earnings, energy_market, hr_personnel, it_systems, travel_logistics, marketing_clients, announcements, scheduling.
105
  3. **sentiment** (`sentiment_score` ∈ [-1, 1], `sentiment_label` ∈
106
  negative/neutral/positive, `sentiment_evidence`) — deterministic lexicon
107
  polarity over the subject + forwarded-tail-stripped body
108
+ ([`sentiment_scorer.py`](https://github.com/Exios66/Enron-Evaluation-Environment/blob/main/scripts/sentiment_scorer.py)),
109
+ negation/intensifier-aware, politeness-formula controlled.
110
 
111
  All three dimensions are HEURISTIC ground truth (deterministic pure functions,
112
  human-reviewed via spot checks where noted) — not hand annotations. Honest
 
122
  dedup/enrichment cannot change any surviving row's split. Coverage: train
123
  222,572 / test 24,951.
124
 
125
+ ## Source data & original download
126
+
127
+ All content derives from the **CMU Enron Email Dataset** — Bryan Klimt and
128
+ Yiming Yang, Carnegie Mellon University, 2004. Original public download
129
+ source: **https://www.cs.cmu.edu/~enron/**
130
+
131
+ - Roughly 500,000 messages from ~150 Enron employees, released by the Federal
132
+ Energy Regulatory Commission during the fraud investigation and cleaned and
133
+ published for research by CMU.
134
+ - We ingest the cleaned `maildir` variant; each row preserves its provenance
135
+ in `metadata.source` (`cmu_enron_maildir`), `metadata.custodian`,
136
+ `metadata.folder`, and `metadata.message_id`.
137
+ - The full-corpus export step (sha256-verified, 517,390 rows) was produced by
138
+ [`publish_enron_correspondence.py`](https://github.com/Exios66/llm-entity-extraction/blob/main/scripts/datasets/publish_enron_correspondence.py);
139
+ dedup uses `body_hash` from
140
+ [`scripts/dedupe.py`](https://github.com/Exios66/Enron-Evaluation-Environment/blob/main/scripts/dedupe.py)
141
+ in Enron-Evaluation-Environment.
142
+
143
+ ## Licensing and appropriate use
144
+
145
+ - Released for **research use**, consistent with the original CMU Enron
146
+ release terms (recorded per-row in `metadata.license`: "Enron corpus —
147
+ released for research use"). Hub license badge: `research-only-enron-corpus`
148
+ (custom, `license: other`).
149
+ - The corpus contains **real personally identifying information** (names,
150
+ addresses, phone numbers) of Enron employees and correspondents. Treat all
151
+ rows as sensitive research data: no redistribution of raw PII outside
152
+ research contexts, and no use in production or consumer-facing systems.
153
+ - Label columns are deterministic heuristics (see honest-gaps notes above),
154
+ suitable as routing priors and weak supervision — not as gold human
155
+ annotation.
156
+ - Provided as-is, with no warranty of any kind. Downstream users are
157
+ responsible for complying with the original CMU/FERC terms.
158
+
159
+ ## Related projects
160
+
161
+ - [LLM Mailroom](https://github.com/Exios66/llm-mailroom) — the agentic
162
+ email-triage system this benchmark evaluates; the blind/ground-truth split
163
+ exists precisely so sorting agents can be scored without label leakage.
164
+ - [Enron-Evaluation-Environment](https://github.com/Exios66/Enron-Evaluation-Environment) —
165
+ labelers (`correspondence_subclasses.py`, `content_topics.py`,
166
+ `sentiment_scorer.py`) and the dedup rule (`scripts/dedupe.py::body_hash`).
167
+ - [llm-entity-extraction](https://github.com/Exios66/llm-entity-extraction) —
168
+ dataset publishing pipelines (`scripts/datasets/publish_enron_*.py`).
169
+ - Companion Hub datasets from the same family:
170
+ [legalbench-full](https://huggingface.co/datasets/Lucius-Morningstar/legalbench-full),
171
+ [docclass-merged](https://huggingface.co/datasets/Lucius-Morningstar/docclass-merged),
172
+ [mailroom-cuad-contracts](https://huggingface.co/datasets/Lucius-Morningstar/mailroom-cuad-contracts),
173
+ [mailroom-cuad-contracts-full](https://huggingface.co/datasets/Lucius-Morningstar/mailroom-cuad-contracts-full).
174
+
175
+ Note: an earlier companion repo `Lucius-Morningstar/enron-correspondence` (the
176
+ pre-dedup full corpus) is no longer published on the Hub; reproduce it with
177
+ `publish_enron_correspondence.py` instead.
178
+
179
+ ## Citation
180
+
181
+ If you use this dataset, please cite both the dataset and the underlying
182
+ corpus:
183
+
184
+ ```bibtex
185
+ @misc{morningstar2026enroncorrespondencededup,
186
+ title = {Enron Correspondence Deduplicated (Enriched GT, Agent-Blind Default)},
187
+ author = {Lucius-Morningstar},
188
+ year = {2026},
189
+ month = {August},
190
+ howpublished = {\url{https://huggingface.co/datasets/Lucius-Morningstar/enron-correspondence-dedup}},
191
+ }
192
+
193
+ @inproceedings{klimt2004enron,
194
+ title = {The Enron Corpus: A New Dataset for Email Classification Research},
195
+ author = {Klimt, Bryan and Yang, Yiming},
196
+ booktitle = {European Conference on Machine Learning (ECML 2004)},
197
+ pages = {217--226},
198
+ year = {2004}
199
+ }
200
+ ```
201
+
202
  ## Provenance
203
 
204
  Built by [`llm-entity-extraction`](https://github.com/Exios66/llm-entity-extraction)
205
  `scripts/datasets/publish_enron_correspondence_dedup.py` (KANBAN-079,
206
  2026-08-23T18:52:37+00:00) from the sha256-verified full-corpus export (LFS
207
+ `0554a5973935…`). Labelers and dedup rule: Enron-Evaluation-Environment
208
+ `scripts/` (`correspondence_subclasses.py`, `content_topics.py`,
209
+ `sentiment_scorer.py`, `dedupe.py`). Source: CMU Enron Email Dataset (cleaned
210
+ maildir). Parquet shards added 2026-08-23 (same-day viewer fix, verified
211
+ row-for-row against the JSONL originals).
212
+
213
+ ## Maintenance
214
+
215
+ Issues and fixes: [llm-entity-extraction issues](https://github.com/Exios66/llm-entity-extraction/issues)
216
+ or contact [@Lucius-Morningstar](https://huggingface.co/Lucius-Morningstar)
217
+ on the Hub.