Add README documentation
Browse files
README.md
CHANGED
|
@@ -1,63 +1,45 @@
|
|
| 1 |
---
|
| 2 |
-
|
| 3 |
-
features:
|
| 4 |
-
- name: id
|
| 5 |
-
dtype: string
|
| 6 |
-
- name: title
|
| 7 |
-
dtype: string
|
| 8 |
-
- name: content
|
| 9 |
-
list:
|
| 10 |
-
- name: id
|
| 11 |
-
dtype: string
|
| 12 |
-
- name: sentence
|
| 13 |
-
dtype: string
|
| 14 |
-
- name: tokens
|
| 15 |
-
list: string
|
| 16 |
-
- name: events
|
| 17 |
-
list:
|
| 18 |
-
- name: id
|
| 19 |
-
dtype: string
|
| 20 |
-
- name: type
|
| 21 |
-
dtype: string
|
| 22 |
-
- name: type_id
|
| 23 |
-
dtype: int64
|
| 24 |
-
- name: mention
|
| 25 |
-
list:
|
| 26 |
-
- name: id
|
| 27 |
-
dtype: string
|
| 28 |
-
- name: trigger_word
|
| 29 |
-
dtype: string
|
| 30 |
-
- name: sent_id
|
| 31 |
-
dtype: int64
|
| 32 |
-
- name: offset
|
| 33 |
-
list: int64
|
| 34 |
-
- name: arguments
|
| 35 |
-
list:
|
| 36 |
-
- name: text
|
| 37 |
-
dtype: string
|
| 38 |
-
- name: role
|
| 39 |
-
dtype: string
|
| 40 |
-
- name: negative_triggers
|
| 41 |
-
list: 'null'
|
| 42 |
-
splits:
|
| 43 |
-
- name: train
|
| 44 |
-
num_bytes: 4845983
|
| 45 |
-
num_examples: 529
|
| 46 |
-
- name: validation
|
| 47 |
-
num_bytes: 363584
|
| 48 |
-
num_examples: 28
|
| 49 |
-
- name: test
|
| 50 |
-
num_bytes: 366409
|
| 51 |
-
num_examples: 40
|
| 52 |
-
download_size: 2064171
|
| 53 |
-
dataset_size: 5575976
|
| 54 |
-
configs:
|
| 55 |
-
- config_name: default
|
| 56 |
-
data_files:
|
| 57 |
-
- split: train
|
| 58 |
-
path: data/train-*
|
| 59 |
-
- split: validation
|
| 60 |
-
path: data/validation-*
|
| 61 |
-
- split: test
|
| 62 |
-
path: data/test-*
|
| 63 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
| 4 |
+
|
| 5 |
+
# ACE Dataset Metadata
|
| 6 |
+
|
| 7 |
+
This repository contains metadata files for the ACE (Automatic Content Extraction) event detection dataset.
|
| 8 |
+
|
| 9 |
+
## Files
|
| 10 |
+
|
| 11 |
+
- **streams.json**: 5 items
|
| 12 |
+
- **onestreams.json**: 1 items
|
| 13 |
+
- **label2id.json**: 33 keys
|
| 14 |
+
- **label_freq.json**: 33 keys
|
| 15 |
+
- **id2tokens.json**: 34 keys
|
| 16 |
+
|
| 17 |
+
## File Descriptions
|
| 18 |
+
|
| 19 |
+
- **streams.json**: Contains the task stream configurations for continual learning
|
| 20 |
+
- **onestreams.json**: Single-stream configuration variant
|
| 21 |
+
- **label2id.json**: Mapping from event type labels to numerical IDs
|
| 22 |
+
- **label_freq.json**: Frequency distribution of event types in the dataset
|
| 23 |
+
- **id2tokens.json**: Mapping from IDs to token representations
|
| 24 |
+
|
| 25 |
+
## Usage
|
| 26 |
+
|
| 27 |
+
```python
|
| 28 |
+
import json
|
| 29 |
+
from huggingface_hub import hf_hub_download
|
| 30 |
+
|
| 31 |
+
# Download a specific file
|
| 32 |
+
label2id_path = hf_hub_download(
|
| 33 |
+
repo_id="{repo_id}",
|
| 34 |
+
filename="label2id.json",
|
| 35 |
+
repo_type="{repo_type}"
|
| 36 |
+
)
|
| 37 |
+
|
| 38 |
+
# Load the file
|
| 39 |
+
with open(label2id_path, 'r') as f:
|
| 40 |
+
label2id = json.load(f)
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
## Citation
|
| 44 |
+
|
| 45 |
+
If you use this dataset, please cite the original ACE dataset and related work.
|