saattrupdan commited on
Commit
07d3cd7
1 Parent(s): 567a4b2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -0
README.md CHANGED
@@ -37,6 +37,22 @@ The model will predict the following four entities:
37
  | `MISC` | Miscellaneous | A named entity of a different kind (e.g., *British Pound* or *Mona Lisa*) |
38
 
39
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
  ## Performance
41
 
42
  The following is the Micro-F1 NER performance on Scandinavian NER test datasets, compared with the current state-of-the-art. The models have been evaluated on the test set along with 9 bootstrapped versions of it, with the mean and 95% confidence interval shown here:
37
  | `MISC` | Miscellaneous | A named entity of a different kind (e.g., *British Pound* or *Mona Lisa*) |
38
 
39
 
40
+ ## Use
41
+
42
+ You can use this model in your scripts as follows:
43
+
44
+ ```python
45
+ >>> from transformers import pipeline
46
+ >>> import pandas as pd
47
+ >>> ner = pipeline(task='ner', model='saattrupdan/nbailab-base-ner-scandi', aggregation_strategy='first')
48
+ >>> result = ner('Borghild kjøper seg inn i Bunnpris')
49
+ >>> pd.DataFrame.from_records(result)
50
+ entity_group score word start end
51
+ 0 PER 0.981257 Borghild 0 8
52
+ 1 ORG 0.974099 Bunnpris 26 34
53
+ ```
54
+
55
+
56
  ## Performance
57
 
58
  The following is the Micro-F1 NER performance on Scandinavian NER test datasets, compared with the current state-of-the-art. The models have been evaluated on the test set along with 9 bootstrapped versions of it, with the mean and 95% confidence interval shown here: