tomaarsen HF staff commited on
Commit
3b0b9ae
1 Parent(s): 0fc47bd

Add limitation due to RoBERTa

Browse files
Files changed (1) hide show
  1. README.md +14 -0
README.md CHANGED
@@ -68,4 +68,18 @@ model = SpanMarkerModel.from_pretrained("tomaarsen/span-marker-xlm-roberta-large
68
  entities = model.predict("Amelia Earhart flew her single engine Lockheed Vega 5B across the Atlantic to Paris.")
69
  ```
70
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  See the [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) repository for documentation and additional information on this library.
 
68
  entities = model.predict("Amelia Earhart flew her single engine Lockheed Vega 5B across the Atlantic to Paris.")
69
  ```
70
 
71
+ ### Limitations
72
+
73
+ **Warning**: This model works best when punctuation is separated from the prior words, so
74
+ ```python
75
+ # ✅
76
+ model.predict("He plays J. Robert Oppenheimer , an American theoretical physicist .")
77
+ # ❌
78
+ model.predict("He plays J. Robert Oppenheimer, an American theoretical physicist.")
79
+
80
+ # You can also supply a list of words directly: ✅
81
+ model.predict(["He", "plays", "J.", "Robert", "Oppenheimer", ",", "an", "American", "theoretical", "physicist", "."])
82
+ ```
83
+ The same may be beneficial for some languages, such as splitting `"l'ocean Atlantique"` into `"l' ocean Atlantique"`.
84
+
85
  See the [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) repository for documentation and additional information on this library.