add README.md

README.md

@@ -31,6 +31,40 @@ CamemBERT-bio-gliner is a Named Entity Recognition (NER) model capable of identi
 
 This is the v0.1 of the CamemBERT-bio-gliner model. There might be a few quirks or unexpected predictions. So, if you notice anything off or have suggestions for improvements, we'd really appreciate hearing from you!
 
+## Installation
+To use this model, you must install the GLiNER Python library:
+```
+!pip install gliner
+```
+
+## Usage
+Once you've downloaded the GLiNER library, you can import the GLiNER class. You can then load this model using `GLiNER.from_pretrained` and predict entities with `predict_entities`.
+
+```python
+from gliner import GLiNER
+
+model = GLiNER.from_pretrained("almanach/camembert-bio-gliner-v0.1")
+
+text = """
+Mme A.P. âgée de 52 ans, non tabagique, ayant un diabète de type 2 a été hospitalisée pour une pneumopathie infectieuse. Cette patiente présentait depuis 2 ans des infections respiratoires traités en ambulatoire. L’examen physique a trouvé une fièvre à 38ºc et un foyer de râles crépitants de la base pulmonaire droite.
+"""
+
+labels = ["Âge", "Patient", "Maladie", "Symptômes"]
+
+entities = model.predict_entities(text, labels, threshold=0.5, flat_ner=True)
+
+for entity in entities:
+    print(entity["text"], "=>", entity["label"])
+```
+
+```bash
+Mme A.P. => Patient
+52 ans => Âge
+pneumopathie infectieuse => Maladie
+infections respiratoires => Maladie
+fièvre => Symptômes
+râles crépitants => Symptômes
+```
 
 ## Links