Add README.md

README.md

@@ -1,220 +1,93 @@
 ---
-dataset_info:
-- config_name: conditional_list_extraction
-  features:
-  - name: id
-    dtype: string
-  - name: source
-    dtype: string
-  - name: split
-    dtype: string
-  - name: state
-    dtype: string
-  - name: fields
-    list:
-    - name: name
-      dtype: string
-    - name: type
-      dtype: string
-    - name: instruction
-      dtype: string
-  - name: answers
-    list:
-    - name: 'null'
-      dtype: bool
-    - name: values
-      list:
-      - name: text
-        dtype: string
-      - name: start
-        dtype: int32
-      - name: end
-        dtype: int32
-  - name: metadata
-    dtype: string
-  - name: level
-    dtype: int32
-  splits:
-  - name: train
-    num_bytes: 13433915
-    num_examples: 10000
-  - name: validation
-    num_bytes: 681606
-    num_examples: 500
-  - name: test
-    num_bytes: 656896
-    num_examples: 500
-  download_size: 7721164
-  dataset_size: 14772417
-- config_name: log_query_extraction
-  features:
-  - name: id
-    dtype: string
-  - name: source
-    dtype: string
-  - name: split
-    dtype: string
-  - name: state
-    dtype: string
-  - name: fields
-    list:
-    - name: name
-      dtype: string
-    - name: type
-      dtype: string
-    - name: instruction
-      dtype: string
-  - name: answers
-    list:
-    - name: 'null'
-      dtype: bool
-    - name: values
-      list:
-      - name: text
-        dtype: string
-      - name: start
-        dtype: int32
-      - name: end
-        dtype: int32
-  - name: metadata
-    dtype: string
-  - name: level
-    dtype: int32
-  splits:
-  - name: train
-    num_bytes: 19727728
-    num_examples: 10000
-  - name: validation
-    num_bytes: 961990
-    num_examples: 500
-  - name: test
-    num_bytes: 1002711
-    num_examples: 500
-  download_size: 10309419
-  dataset_size: 21692429
-- config_name: record_field_extraction
-  features:
-  - name: id
-    dtype: string
-  - name: source
-    dtype: string
-  - name: split
-    dtype: string
-  - name: state
-    dtype: string
-  - name: fields
-    list:
-    - name: name
-      dtype: string
-    - name: type
-      dtype: string
-    - name: instruction
-      dtype: string
-  - name: answers
-    list:
-    - name: 'null'
-      dtype: bool
-    - name: values
-      list:
-      - name: text
-        dtype: string
-      - name: start
-        dtype: int32
-      - name: end
-        dtype: int32
-  - name: metadata
-    dtype: string
-  - name: level
-    dtype: int32
-  splits:
-  - name: train
-    num_bytes: 9442691
-    num_examples: 10000
-  - name: validation
-    num_bytes: 501206
-    num_examples: 500
-  - name: test
-    num_bytes: 469015
-    num_examples: 500
-  download_size: 5333845
-  dataset_size: 10412912
-- config_name: state_update_extraction
-  features:
-  - name: id
-    dtype: string
-  - name: source
-    dtype: string
-  - name: split
-    dtype: string
-  - name: state
-    dtype: string
-  - name: fields
-    list:
-    - name: name
-      dtype: string
-    - name: type
-      dtype: string
-    - name: instruction
-      dtype: string
-  - name: answers
-    list:
-    - name: 'null'
-      dtype: bool
-    - name: values
-      list:
-      - name: text
-        dtype: string
-      - name: start
-        dtype: int32
-      - name: end
-        dtype: int32
-  - name: metadata
-    dtype: string
-  - name: level
-    dtype: int32
-  splits:
-  - name: train
-    num_bytes: 12773776
-    num_examples: 10000
-  - name: validation
-    num_bytes: 645531
-    num_examples: 500
-  - name: test
-    num_bytes: 637604
-    num_examples: 500
-  download_size: 7015857
-  dataset_size: 14056911
+pretty_name: procedural-extraction
+language:
+- en
+license: mit
+task_categories:
+- token-classification
+- question-answering
+tags:
+- tasksource
+- jev
+- extraction
+- clairic
+- procedural
+- synthetic
 configs:
-- config_name: conditional_list_extraction
+- config_name: record_field_extraction
   data_files:
   - split: train
-    path: conditional_list_extraction/train-*
+    path: record_field_extraction/train-*.parquet
   - split: validation
-    path: conditional_list_extraction/validation-*
+    path: record_field_extraction/validation-*.parquet
   - split: test
-    path: conditional_list_extraction/test-*
-- config_name: log_query_extraction
+    path: record_field_extraction/test-*.parquet
+- config_name: state_update_extraction
   data_files:
   - split: train
-    path: log_query_extraction/train-*
+    path: state_update_extraction/train-*.parquet
   - split: validation
-    path: log_query_extraction/validation-*
+    path: state_update_extraction/validation-*.parquet
   - split: test
-    path: log_query_extraction/test-*
-- config_name: record_field_extraction
+    path: state_update_extraction/test-*.parquet
+- config_name: conditional_list_extraction
   data_files:
   - split: train
-    path: record_field_extraction/train-*
+    path: conditional_list_extraction/train-*.parquet
   - split: validation
-    path: record_field_extraction/validation-*
+    path: conditional_list_extraction/validation-*.parquet
   - split: test
-    path: record_field_extraction/test-*
-- config_name: state_update_extraction
+    path: conditional_list_extraction/test-*.parquet
+- config_name: log_query_extraction
   data_files:
   - split: train
-    path: state_update_extraction/train-*
+    path: log_query_extraction/train-*.parquet
   - split: validation
-    path: state_update_extraction/validation-*
+    path: log_query_extraction/validation-*.parquet
   - split: test
-    path: state_update_extraction/test-*
+    path: log_query_extraction/test-*.parquet
 ---
+
+# procedural-extraction
+
+Procedurally generated extraction requests: one text and several typed fields to fill from it in one pass, as
+extraction models (e.g. Cloudflare's Clairic) are asked. Each field is `text` (one span) or `list` (every
+matching span) and is answered with character spans of the text or null. Answers are computed by construction,
+so spans are exact and labels noise-free; nulls are earned (the text mentions a negated, proposed, former or
+other entity's value, not nothing). The tasks are generated by
+[reasoning-core](https://github.com/sileod/reasoning-core) (commit `38b6189`, see
+[provenance.json](provenance.json)) and are a procedural component of the `extraction` config of
+[tasksource-jev-typed-decisions](https://huggingface.co/datasets/tasksource/tasksource-jev-typed-decisions).
+
+| config | what is extracted |
+|---|---|
+| `record_field_extraction` | A person's city, employer, job title, phone, email and birth date, from prose about several people with near-miss names; negated, former, hoped-for and relatives' values as confusers; "same city/company as X" chains |
+| `state_update_extraction` | The value in force (or before the last change) of plan slots, from a timestamped chat of statements, proposals approved/rejected/pending, corrections and undos, out of order from level 2 |
+| `conditional_list_extraction` | Every order id or product meeting conjunctive, negated or numeric conditions after later updates, or the heaviest such order; prose, bullets or a table |
+| `log_query_extraction` | Every request id or user of log lines matching filters on level, exact service (auth vs auth-proxy), status, latency and user, or the latest/slowest match; plain, logfmt or JSON lines |
+
+Levels 0 to 4 are drawn uniformly; `level` is a column. Mean per-field score by level (0 / 1 / 2 / 3 / 4):
+
+| config | train | validation | test | DeepSeek-v4-flash | GLiNER-large |
+|---|---|---|---|---|---|
+| `record_field_extraction` | 10,000 | 500 | 500 | 1.00 / 0.91 / 0.84 / 0.67 / 0.58 | 0.76 / 0.64 / 0.46 / 0.41 / 0.38 |
+| `state_update_extraction` | 10,000 | 500 | 500 | 0.84 / 0.76 / 0.77 / 0.68 / 0.51 | 0.58 / 0.46 / 0.37 / 0.36 / 0.29 |
+| `conditional_list_extraction` | 10,000 | 500 | 500 | 0.88 / 0.79 / 0.70 / 0.64 / 0.52 | 0.29 / 0.17 / 0.12 / 0.05 / 0.10 |
+| `log_query_extraction` | 10,000 | 500 | 500 | 0.86 / 0.76 / 0.68 / 0.63 / 0.59 | 0.31 / 0.16 / 0.09 / 0.24 / 0.15 |
+
+## Schema
+
+`state` (the text), `fields` (`[{name, type, instruction}]`), `answers` (one per field: `{null, values:
+[{text, start, end}]}`, `state[start:end] == text`), `metadata` (JSON: level, state seed), `level`.
+
+## Citation
+
+```bibtex
+@inproceedings{sileo-2024-tasksource,
+    title = "tasksource: A Large Collection of {NLP} tasks with a Structured Dataset Preprocessing Framework",
+    author = "Sileo, Damien",
+    booktitle = "Proceedings of the 2024 Joint International Conference on Computational Linguistics, Language Resources and Evaluation (LREC-COLING 2024)",
+    year = "2024",
+    url = "https://aclanthology.org/2024.lrec-main.1361",
+}
+```