Update README.md

README.md

@@ -32,6 +32,48 @@ model-index:
 This model was finetuned using the [GLiNER v2.5 suite](https://github.com/urchade/GLiNER) of models.
 You can find and replicate the training pipeline on [Github](https://github.com/ljvmiranda921/calamanCy/tree/master/models/v0.1.0-gliner).
 
+## Usage
+
+```python
+from gliner import GLiNER
+
+# Initialize GLiNER with the base model
+model = GLiNER.from_pretrained("ljvmiranda921/tl_gliner_small")
+
+# Sample text for entity prediction
+# Reference: Leni Robredo’s speech at the 2022 UP College of Law recognition rites
+text = """"
+Nagsimula ako sa Public Attorney’s Office, kung saan araw-araw, mula Lunes hanggang Biyernes, nasa loob ako ng iba’t ibang court room at tambak ang kaso.
+Bawat Sabado, nasa BJMP ako para ihanda ang aking mga kliyente. Nahasa ako sa crim law at litigation. Pero kinalaunan, lumipat ako sa isang NGO,
+‘yung Sentro ng Alternatibong Lingap Panligal. Sa SALIGAN talaga ako nahubog bilang abugado: imbes na tinatanggap na lang ang mga batas na kailangang
+sundin, nagtatanong din kung ito ba ay tunay na instrumento para makapagbigay ng katarungan sa ordinaryong Pilipino. Imbes na maghintay ng mga kliyente
+sa de-aircon na opisina, dinadayo namin ang mga malalayong komunidad. Kadalasan, naka-tsinelas, naka-t-shirt at maong, hinahanap namin ang mga komunidad,
+tinatawid ang mga bundok, palayan, at mga ilog para tumungo sa mga lugar kung saan hirap ang mga batayang sektor na makakuha ng access to justice.
+Naaalala ko pa noong naging lead lawyer ako para sa isang proyekto: sa loob ng mahigit dalawang taon, bumibiyahe ako buwan-buwan papunta sa malayong
+isla ng Masbate, nagpa-paralegal training sa mga batayang sektor doon, ipinapaliwanag, itinituturo, at sinasanay sila sa mga batas na nagbibigay-proteksyon
+sa mga karapatan nila.
+"""
+
+# Labels for entity prediction
+# Most GLiNER models should work best when entity types are in lower case or title case
+labels = ["person", "organization", "location"]
+
+# Perform entity prediction
+entities = model.predict_entities(text, labels, threshold=0.5)
+
+# Display predicted entities and their labels
+for entity in entities:
+    print(entity["text"], "=>", entity["label"])
+
+# Sample output:
+# Public Attorney’s Office => organization
+# BJMP => organization
+# Sentro ng Alternatibong Lingap Panligal => organization
+# Masbate => location
+
+```
+
+
 ## Citation
 
 Please cite the following papers when using these models: