Upload README.md with huggingface_hub

README.md

@@ -1,4 +1,24 @@
 ---
+annotations_creators:
+  - expert-generated
+language_creators:
+  - found
+language:
+  - en
+license:
+  - other
+multilinguality:
+  - monolingual
+size_categories:
+  - 10K<n<100K
+source_datasets:
+  - original
+task_categories:
+  - token-classification
+task_ids:
+  - named-entity-recognition
+paperswithcode_id: crossner
+pretty_name: CrossNER-AI
 dataset_info:
   features:
   - name: tokens
@@ -7,54 +27,98 @@ dataset_info:
     sequence:
       class_label:
         names:
-          '0': O
-          '1': B-field
-          '2': I-field
-          '3': B-task
-          '4': I-task
-          '5': B-product
-          '6': I-product
-          '7': B-algorithm
-          '8': I-algorithm
-          '9': B-researcher
-          '10': I-researcher
-          '11': B-metrics
-          '12': I-metrics
-          '13': B-programlang
-          '14': I-programlang
-          '15': B-conference
-          '16': I-conference
-          '17': B-university
-          '18': I-university
-          '19': B-country
-          '20': I-country
-          '21': B-person
-          '22': I-person
-          '23': B-organisation
-          '24': I-organisation
-          '25': B-location
-          '26': I-location
-          '27': B-misc
-          '28': I-misc
+            "0": O
+            "1": B-field
+            "2": I-field
+            "3": B-task
+            "4": I-task
+            "5": B-product
+            "6": I-product
+            "7": B-algorithm
+            "8": I-algorithm
+            "9": B-researcher
+            "10": I-researcher
+            "11": B-metrics
+            "12": I-metrics
+            "13": B-programlang
+            "14": I-programlang
+            "15": B-conference
+            "16": I-conference
+            "17": B-university
+            "18": I-university
+            "19": B-country
+            "20": I-country
+            "21": B-person
+            "22": I-person
+            "23": B-organisation
+            "24": I-organisation
+            "25": B-location
+            "26": I-location
+            "27": B-misc
+            "28": I-misc
   splits:
   - name: train
-    num_bytes: 64490
+    num_bytes: 10000
     num_examples: 100
   - name: validation
-    num_bytes: 187113
+    num_bytes: 35000
     num_examples: 350
   - name: test
-    num_bytes: 222784
+    num_bytes: 43100
     num_examples: 431
-  download_size: 125361
-  dataset_size: 474387
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: validation
-    path: data/validation-*
-  - split: test
-    path: data/test-*
 ---
+
+# CrossNER AI Dataset
+
+An NER dataset for cross-domain evaluation, [read more](https://arxiv.org/abs/2012.04373).  
+This split contains labeled data from the AI domain.
+
+## Features
+
+- **tokens**: A list of words in the sentence
+- **ner_tags**: A list of NER labels (as integers) corresponding to each token
+
+## Label Mapping
+
+The dataset uses the following 29 labels:
+
+| Index | Label |
+|-------|-------|
+| 0 | O |
+| 1 | B-field |
+| 2 | I-field |
+| 3 | B-task |
+| 4 | I-task |
+| 5 | B-product |
+| 6 | I-product |
+| 7 | B-algorithm |
+| 8 | I-algorithm |
+| 9 | B-researcher |
+| 10 | I-researcher |
+| 11 | B-metrics |
+| 12 | I-metrics |
+| 13 | B-programlang |
+| 14 | I-programlang |
+| 15 | B-conference |
+| 16 | I-conference |
+| 17 | B-university |
+| 18 | I-university |
+| 19 | B-country |
+| 20 | I-country |
+| 21 | B-person |
+| 22 | I-person |
+| 23 | B-organisation |
+| 24 | I-organisation |
+| 25 | B-location |
+| 26 | I-location |
+| 27 | B-misc |
+| 28 | I-misc |
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("eesuhn/crossner-ai")
+```
+