Update README.md

README.md

@@ -9,7 +9,7 @@ library_name: transformers
 tags:
 - legal
 ---
-# sempl-it-v3-proofreading-awq
+# sempl-it-v3-explain-awq
 SEMPL-IT aims to simplify Italian administrative texts using a progressive approach based on multiple specialized models. 
 Each model addresses a specific aspect of the text transformation process, ensuring a step-by-step refinement.
 
@@ -23,4 +23,85 @@ The complete text simplification pipeline follows eight sequential steps:
 6. [nominalizations](https://huggingface.co/VerbACxSS/sempl-it-v3-nominalizations-awq)
 7. [verbs](https://huggingface.co/VerbACxSS/sempl-it-v3-verbs-awq)
 8. [sentence-reorganizer](https://huggingface.co/VerbACxSS/sempl-it-v3-sentence-reorganizer-awq)
-9. [explain](https://huggingface.co/VerbACxSS/sempl-it-v3-explain-awq) (this)
+9. [explain](https://huggingface.co/VerbACxSS/sempl-it-v3-explain-awq) (this)
+
+
+## Web App
+To integrate this model into the full system, check out:
+- Frontend: [GitHub Repository](https://github.com/VerbACxSS/sempl-it-frontend)
+- Backend: [GitHub Repository](https://github.com/VerbACxSS/sempl-it-backend)
+- Inference: [GitHub Repository](https://github.com/VerbACxSS/sempl-it-inference)
+
+## Usage
+Install the following dependencies:
+```sh
+pip install transformers==4.49.0
+pip install autoawq==0.2.9
+pip install peft==0.15.0
+```
+
+Define the system prompt and the text to simplify:
+```py
+PROMPT = """Sei un esperto redattore di documenti istituzionali italiani.
+
+Riscrivi il testo per renderlo semplice e comprensibile per i cittadini. Il testo riscritto deve contenere tutte le informazioni del testo originale ma organizzate in modo che siano facilmente accessibili ai cittadini. 
+
+Applica le seguenti regole per riscrivere il testo:
+- Utilizza parole ed espressioni semplici;
+- Utilizza frasi breve, semplici e dirette;
+- Non eliminare le parole tecniche e giuridiche, ma spiegale tra parentesi con parole o espressioni semplici e comprensibili;
+- Dividi il testo in paragrafi logicamente indipendenti;
+- Il soggetto delle frasi deve essere sempre chiaro;
+- Usa forme e tempi verbali semplici;
+- Rimuovi i riferimenti normativi superflui.
+
+# Output Format
+Il testo riscritto e semplificato senza nessuna formattazione.
+
+# Notes
+- Il testo fornito può essere complesso e richiede attenzione ai dettagli.
+- Assicurati che le implicazioni giuridiche e legali del documento siano mantenute.
+- Non modificare il testo tra virgolette."""
+
+TEXT_TO_SIMPLIFY = """Il documento individua le esigenze di sviluppo necessarie per assicurare che i principi delineati dalla Legge Regionale 23 dicembre 2004, n. 29 e dai successivi atti normativi, sulla essenziale funzione della ricerca e innovazione nelle Aziende Sanitarie della Regione Emilia-Romagna, si traducano in azioni concrete nel Servizio Sanitario Regionale. 
+
+Alla luce delle evidenze della letteratura internazionale, delle indicazioni della normativa nazionale e della valutazione di quanto già attuato a livello regionale negli anni passati, vengono individuati gli obiettivi di sviluppo e le linee per il raggiungimento dei suddetti obiettivi."""
+```
+
+Load SEMPL-IT model and tokenizer:
+```py
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+tokenizer = AutoTokenizer.from_pretrained("VerbACxSS/sempl-it-v3-explain-awq")
+model = AutoModelForCausalLM.from_pretrained("VerbACxSS/sempl-it-v3-explain-awq").to("cuda")
+```
+
+Define and apply chat template:
+```py
+chat = [
+  {"role": "system", "content": PROMPT},
+  {"role": "assistant", "content": TEXT_TO_SIMPLIFY},
+]
+
+formatted_chat = tokenizer.apply_chat_template(
+    chat,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([formatted_chat], return_tensors="pt").to("cuda")
+```
+
+Use SEMPL_IT model with following sampling parameters to generate `simplified_text`:
+```py
+generated_ids = model.generate(
+    **model_inputs,
+    max_new_tokens=4096,
+    temperature=0.1,
+    top_p=0.2
+)
+simplified_text = tokenizer.decode(generated_ids[0][len(model_inputs.input_ids[0]):], skip_special_tokens=True)
+print(simplified_text)
+```
+
+## Acknowledgements
+This contribution is a result of the research conducted within the framework of the PRIN 2020 (Progetti di Rilevante Interesse Nazionale) "VerbACxSS: on analytic verbs, complexity, synthetic verbs, and simplification. For accessibility" (Prot. 2020BJKB9M), funded by the Italian Ministero dell'Università e della Ricerca.