GLiNER/README.md

Model Card for GLiNER-base

GLiNER is a Named Entity Recognition (NER) model capable of identifying any entity type using a bidirectional transformer encoder (BERT-like). It provides a practical alternative to traditional NER models, which are limited to predefined entities, and Large Language Models (LLMs) that, despite their flexibility, are costly and large for resource-constrained scenarios.

Models Status

Available Models on Hugging Face

• GLiNER-Base (CC BY NC 4.0)
• GLiNER-Multi (CC BY NC 4.0)
• GLiNER-small (CC BY NC 4.0)
• GLiNER-small-v2 (Apache)
• GLiNER-medium (CC BY NC 4.0)
• GLiNER-medium-v2 (Apache)
• GLiNER-large (CC BY NC 4.0)
• GLiNER-ledium-v2 (Apache)

To Release

• ⏳ GLiNER-Multiv2
• ⏳ GLiNER-Sup (trained on mixture of NER datasets)

Links

• Paper: https://arxiv.org/abs/2311.08526
• Repository: https://github.com/urchade/GLiNER

Installation

To use this model, you must download the GLiNER repository and install its dependencies:

!git clone https://github.com/urchade/GLiNER.git
%cd GLiNER
!pip install -r requirements.txt

Usage

Once you've downloaded the GLiNER repository, you can import the GLiNER class from the model file. You can then load this model using GLiNER.from_pretrained and predict entities with predict_entities.

from model import GLiNER

model = GLiNER.from_pretrained("urchade/gliner_base")

text = """
Cristiano Ronaldo dos Santos Aveiro (Portuguese pronunciation: [kɾiʃˈtjɐnu ʁɔˈnaldu]; born 5 February 1985) is a Portuguese professional footballer who plays as a forward for and captains both Saudi Pro League club Al Nassr and the Portugal national team. Widely regarded as one of the greatest players of all time, Ronaldo has won five Ballon d'Or awards,[note 3] a record three UEFA Men's Player of the Year Awards, and four European Golden Shoes, the most by a European player. He has won 33 trophies in his career, including seven league titles, five UEFA Champions Leagues, the UEFA European Championship and the UEFA Nations League. Ronaldo holds the records for most appearances (183), goals (140) and assists (42) in the Champions League, goals in the European Championship (14), international goals (128) and international appearances (205). He is one of the few players to have made over 1,200 professional career appearances, the most by an outfield player, and has scored over 850 official senior career goals for club and country, making him the top goalscorer of all time.
"""

labels = ["person", "award", "date", "competitions", "teams"]

entities = model.predict_entities(text, labels)

for entity in entities:
    print(entity["text"], "=>", entity["label"])

Cristiano Ronaldo dos Santos Aveiro => person
5 February 1985 => date
Al Nassr => teams
Portugal national team => teams
Ballon d'Or => award
UEFA Men's Player of the Year Awards => award
European Golden Shoes => award
UEFA Champions Leagues => competitions
UEFA European Championship => competitions
UEFA Nations League => competitions
Champions League => competitions
European Championship => competitions

Named Entity Recognition benchmark result

Model Authors

The model authors are:

• Urchade Zaratiana
• Nadi Tomeh
• Pierre Holat
• Thierry Charnois

Citation

@misc{zaratiana2023gliner,
      title={GLiNER: Generalist Model for Named Entity Recognition using Bidirectional Transformer}, 
      author={Urchade Zaratiana and Nadi Tomeh and Pierre Holat and Thierry Charnois},
      year={2023},
      eprint={2311.08526},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}