Update README.md

README.md

@@ -62,7 +62,7 @@ configs:
 
 NorNE is a manually annotated corpus of named entities which extends the annotation of the existing Norwegian Dependency Treebank. Comprising both of the official standards of written Norwegian (Bokmål and Nynorsk), the corpus contains around 600,000 tokens and annotates a rich set of entity types including persons,organizations, locations, geo-political entities, products, and events, in addition to a class corresponding to nominals derived from names.
 
-There are 3 main configs in this dataset each with 3 versions of the NER tag set. When accessing the `bokmaal`, `nynorsk`, or `combined` configs the NER tag set will be comprised of 9 tags: `GPE_ORG`, `GPE_LOC`, `ORG`, `LOC`, `PER`, `PROD`, `EVT`, `DRV`, and `MISC`. The two special types `GPE_LOC` and `GPE_ORG` can easily be altered depending on the task, choosing either the more general `GPE` tag or the more specific `LOC`/`ORG` tags, conflating them with the other annotations of the same type. To access these reduced versions of the dataset, you can use the configs `bokmaal-7`, `nynorsk-7`, `combined-7` for the NER tag set with 7 tags ( **`ORG`**, **`LOC`**, `PER`, `PROD`, `EVT`, `DRV`, `MISC`), and `bokmaal-8`, `nynorsk-8`, `combined-8` for the NER tag set with 8 tags (`LOC_` and `ORG_`: **`ORG`**, **`LOC`**, **`GPE`**, `PER`, `PROD`, `EVT`, `DRV`, `MISC`). By default, the full set (9 tags) will be used. See Annotations for further details.
+There are 3 main configs in this dataset each with 3 versions of the NER tag set. When accessing the `bokmaal`, `nynorsk`, or `combined` configs the NER tag set will be comprised of 9 tags: `GPE_ORG`, `GPE_LOC`, `ORG`, `LOC`, `PER`, `PROD`, `EVT`, `DRV`, and `MISC`. The two special types `GPE_LOC` and `GPE_ORG` can easily be altered depending on the task, choosing either the more general `GPE` tag or the more specific `LOC`/`ORG` tags, conflating them with the other annotations of the same type. By default, the full set (9 tags) will be used. See Annotations for further details.
 
 ### Supported Tasks and Leaderboards
 
@@ -78,16 +78,22 @@ Each entry contains text sentences, their language, identifiers, tokens, lemmas,
 
 ### Data Instances
 
-An example of the `train` split of the `bokmaal` config.
+Each example looks as follows:
 
 ```python
-{'idx': '000001',
- 'lang': 'bokmaal',
- 'lemmas': ['lam', 'og', 'piggvar', 'på', 'bryllupsmeny'],
- 'ner_tags': [0, 0, 0, 0, 0],
- 'pos_tags': [0, 9, 0, 5, 0],
- 'text': 'Lam og piggvar på bryllupsmenyen',
- 'tokens': ['Lam', 'og', 'piggvar', 'på', 'bryllupsmenyen']}
+{
+  'id': '004439',
+  'tokens': [
+    'Hos', 'Mendelsohn', 'kan', 'man', 'finne', 'samme', 'fascinasjon',
+    'for', 'språkets', 'sensuelle', 'skjønnhet', 'og', 'glitrende',
+    'musikalitet', 'som', 'hos', 'Proust', '.'
+  ],
+  'tags': [
+    'O', 'B-PER', 'O', 'O', 'O', 'O', 'O',
+    'O', 'O', 'O', 'O', 'O', 'O',
+    'O', 'O', 'O', 'B-PER', 'O'
+  ]
+}
 ```
 
 ### Data Fields
@@ -95,78 +101,11 @@ An example of the `train` split of the `bokmaal` config.
 
 Each entry is annotated with the next fields:
 
-- `idx` (`int`), text (sentence) identifier from the NorNE dataset
-- `lang` (`str`), language variety, either `bokmaal`, `nynorsk` or `combined`
-- `text` (`str`), plain text
-- `tokens` (`List[str]`), list of tokens extracted from `text`
-- `lemmas` (`List[str]`), list of lemmas extracted from `tokens`
-- `ner_tags` (`List[int]`), list of numeric NER tags for each token in `tokens`
-- `pos_tags` (`List[int]`), list of numeric PoS tags for each token in `tokens`
-
-An example DataFrame obtained from the dataset:
-
-<table class="dataframe" border="1">
-  <thead>
-    <tr style="text-align: right;">
-      <th></th>
-      <th>idx</th>
-      <th>lang</th>
-      <th>text</th>
-      <th>tokens</th>
-      <th>lemmas</th>
-      <th>ner_tags</th>
-      <th>pos_tags</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <th>0</th>
-      <td>000001</td>
-      <td>bokmaal</td>
-      <td>Lam og piggvar på bryllupsmenyen</td>
-      <td>[Lam, og, piggvar, på, bryllupsmenyen]</td>
-      <td>[lam, og, piggvar, på, bryllupsmeny]</td>
-      <td>[0, 0, 0, 0, 0]</td>
-      <td>[0, 9, 0, 5, 0]</td>
-    </tr>
-    <tr>
-      <th>1</th>
-      <td>000002</td>
-      <td>bokmaal</td>
-      <td>Kamskjell, piggvar og lammefilet sto på menyen...</td>
-      <td>[Kamskjell, ,, piggvar, og, lammefilet, sto, p...</td>
-      <td>[kamskjell, $,, piggvar, og, lammefilet, stå, ...</td>
-      <td>[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]</td>
-      <td>[0, 1, 0, 9, 0, 15, 2, 0, 2, 8, 6, 0, 1]</td>
-    </tr>
-    <tr>
-      <th>2</th>
-      <td>000003</td>
-      <td>bokmaal</td>
-      <td>Og til dessert: Parfait à la Mette-Marit.</td>
-      <td>[Og, til, dessert, :, Parfait, à, la, Mette-Ma...</td>
-      <td>[og, til, dessert, $:, Parfait, à, la, Mette-M...</td>
-      <td>[0, 0, 0, 0, 7, 8, 8, 8, 0]</td>
-      <td>[9, 2, 0, 1, 10, 12, 12, 10, 1]</td>
-    </tr>
-  </tbody>
-</table>
-
-### Data Splits
-
-There are three splits: `train`, `validation` and `test`.
-
-| Config    | Split        | Total  |
-| :---------|-------------:|-------:|
-| `bokmaal` | `train`      |  15696 |
-| `bokmaal` | `validation` |   2410 |
-| `bokmaal` | `test`       |   1939 |
-| `nynorsk` | `train`      |  14174 |
-| `nynorsk` | `validation` |   1890 |
-| `nynorsk` | `test`       |   1511 |
-| `combined`| `test`       |  29870 |
-| `combined`| `validation` |   4300 |
-| `combined`| `test`       |   3450 |
+- `id` (`str`): an example id
+- `tokens` (`List[str]`), list of tokens
+- `tags` (`List[int]`): list of NER tags for each token in `tokens`
+
+
 
 ## Dataset Creation