README.md

---
license: mit
language:
- it
base_model:
- unsloth/Qwen2.5-7B-Instruct-bnb-4bit
pipeline_tag: text-generation
library_name: transformers
tags:
- legal
---
# sempl-it-proofreading-bnb
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.

## Simplification Pipeline
The complete text simplification pipeline follows eight sequential steps:
1. [proofreading](https://huggingface.co/VerbACxSS/sempl-it-proofreading-bnb)  (this)
2. [lex](https://huggingface.co/VerbACxSS/sempl-it-lex-bnb)
3. [connectives](https://huggingface.co/VerbACxSS/sempl-it-connectives-bnb)
4. [expressions](https://huggingface.co/VerbACxSS/sempl-it-expressions-bnb)
5. [sentence-splitter](https://huggingface.co/VerbACxSS/sempl-it-sentence-splitter-bnb)
6. [nominalizations](https://huggingface.co/VerbACxSS/sempl-it-nominalizations-bnb)
7. [verbs](https://huggingface.co/VerbACxSS/sempl-it-verbs-bnb)
8. [sentence-reorganizer](https://huggingface.co/VerbACxSS/sempl-it-sentence-reorganizer-bnb)

## 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 bitsandbytes==0.45.3
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.

Correggi gli errori ortografici, grammaticali, sintattici, di coesione, di punteggiatura e di preposizioni. **Non alterare il contenuto e lo stile del testo originale**.

# Steps
1. Leggi attentamente il testo istituzionale fornito.
2. Identifica gli errori di ortografia, grammatica, sintassi, coesione, punteggiatura e preposizioni.
3. Correggi gli errori individuati.

# Output Format
Il testo corretto con la stessa formattazione e suddivisione in paragrafi dell'originale.

# Notes
- Il testo fornito può essere complesso e richiede attenzione ai dettagli."""

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-proofreading-bnb")
model = AutoModelForCausalLM.from_pretrained("VerbACxSS/sempl-it-proofreading-bnb").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.