Update README.md

README.md

@@ -4,18 +4,49 @@ language:
 - it
 license: apache-2.0
 tags:
-- text-generation-inference
-- transformers
 - unsloth
-- llama
-- trl
+- llama3
 - NER
 - RE
-- IE
+- OIE
+- LLIMONIIE
 base_model: swap-uniba/LLaMAntino-3-ANITA-8B-Inst-DPO-ITA
 ---
-# Official HF Model Card for the paper : LLIMONIIE: Large Language Instructed Model for Open Named Italian Information Extraction
+# LLIMONIIE: Large Language Instructed Model for Open Named Italian Information Extraction
 
+
+LLIMONIE generalizes IE across diverse domains without requiring input ontologies.
+
+-
+Perform three tasks:
+  - **Open Named Entity Recognition**
+
+  - **Open Relation Extraction**
+
+  - **Joint Entity and Relation Extraction**
+
+
+## 💻 Quick Start
+### Setup conda environment
+Install the unsloth package following the repo [guide](https://github.com/unslothai/unsloth?tab=readme-ov-file#conda-installation)
+### Clone the repository
+```bash
+git clone https://github.com/leonardoPiano/LLIMONIE.git
+```
+### Run the generation
+```python
+from PromptTemplates.instruct_prompt_templates import  NER,RE,JOINT
+from LLM.Unsloth import UnslothLLM
+model_path="leopiano98/LLIMONIE_anita8b"
+
+llimonie=UnslothLLM(model_path,inference=True)
+task=NER
+text="Alessandro Manzoni è considerato uno dei maggiori romanzieri italiani di tutti i tempi per il suo celebre romanzo I promessi sposi"
+messages = [{"role": "system", "content": task},
+                        {"role": "user", "content": text}]
+output= llimonie.generate(messages, max_new_tokens=512)
+#output: Alessandro Manzoni[Writer|Person]; I promessi sposi[Novel|Book]; italiani[Nationality|Ethnicity] 
+```
 - **Developed by:** leopiano98
 - **License:** apache-2.0
 - **Finetuned from model :** swap-uniba/LLaMAntino-3-ANITA-8B-Inst-DPO-ITA