Create README.md

README.md

@@ -0,0 +1,39 @@
+---
+license: apache-2.0
+library_name: span_marker
+tags:
+- span_marker
+- token-classification
+- ner
+- named-entity-recognition
+pipeline_tag: token-classification
+datasets:
+- DFKI-SLT/few-nerd
+language:
+- en
+---
+
+# SpanMarker for Named Entity Recognition
+
+This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model that can be used for Named Entity Recognition. In particular, this SpanMarker model uses [bert-base-cased](https://huggingface.co/bert-base-cased) as the underlying encoder.
+
+## Usage
+
+To use this model for inference, first install the `span_marker` library:
+
+```bash
+pip install span_marker
+```
+
+You can then run inference as follows:
+
+```python
+from span_marker import SpanMarkerModel
+
+# Download from Hub and run inference
+model = SpanMarkerModel.from_pretrained("tomaarsen/span-marker-bert-base-fewnerd-fine-super")
+# Run inference
+entities = model.predict("Amelia Earhart flew her single engine Lockheed Vega 5B across the Atlantic to Paris.")
+```
+
+See the [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) repository for documentation and additional information on this model framework.