davanstrien / span-marker-bert-base-fewnerd-coarse-super

SpanMarker with numind/generic-entity_recognition_NER-v1 on DFKI-SLT/few-nerd

This is a SpanMarker model trained on the DFKI-SLT/few-nerd dataset that can be used for Named Entity Recognition. This SpanMarker model uses numind/generic-entity_recognition_NER-v1 as the underlying encoder.

Model Details

Model Description

• Model Type: SpanMarker
• Encoder: numind/generic-entity_recognition_NER-v1
• Maximum Sequence Length: 256 tokens
• Maximum Entity Length: 19 words
• Training Dataset: DFKI-SLT/few-nerd
• Language: en
• License: mit

Model Sources

• Repository: SpanMarker on GitHub
• Thesis: SpanMarker For Named Entity Recognition

Model Labels

Evaluation

Metrics

Uses

Direct Use for Inference

from span_marker import SpanMarkerModel

# Download from the 🤗 Hub
model = SpanMarkerModel.from_pretrained("span_marker_model_id")
# Run inference
entities = model.predict("Caretaker manager George Goss led them on a run in the FA Cup, defeating Liverpool in round 4, to reach the semi-final at Stamford Bridge, where they were defeated 2–0 by Sheffield United on 28 March 1925.")

Downstream Use

You can finetune this model on your own dataset.

from span_marker import SpanMarkerModel, Trainer

# Download from the 🤗 Hub
model = SpanMarkerModel.from_pretrained("span_marker_model_id")

# Specify a Dataset with "tokens" and "ner_tag" columns
dataset = load_dataset("conll2003") # For example CoNLL2003

# Initialize a Trainer using the pretrained model & dataset
trainer = Trainer(
    model=model,
    train_dataset=dataset["train"],
    eval_dataset=dataset["validation"],
)
trainer.train()
trainer.save_model("span_marker_model_id-finetuned")

Training Details

Training Set Metrics

Training Hyperparameters

• learning_rate: 5e-05
• train_batch_size: 64
• eval_batch_size: 128
• seed: 42
• gradient_accumulation_steps: 2
• total_train_batch_size: 128
• optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
• lr_scheduler_type: linear
• lr_scheduler_warmup_ratio: 0.1
• num_epochs: 10
• mixed_precision_training: Native AMP

Training Results

Framework Versions

• Python: 3.10.12
• SpanMarker: 1.5.0
• Transformers: 4.35.2
• PyTorch: 2.1.0+cu118
• Datasets: 2.14.7
• Tokenizers: 0.15.0

Citation

BibTeX

@software{Aarsen_SpanMarker,
    author = {Aarsen, Tom},
    license = {Apache-2.0},
    title = {{SpanMarker for Named Entity Recognition}},
    url = {https://github.com/tomaarsen/SpanMarkerNER}
}