README.md

---
license: apache-2.0
datasets:
- ReDiX/xlam-function-calling-60k-ita
language:
- it
- code
pipeline_tag: text-generation
library_name: transformers
tags:
- unsloth
- trl
---

<img src="banner.webp" style="width: 300px; height:auto">

# ReDiX 1.5B JSON MODE and FUNCTION CALLING


This model is a finetuned version of [Qwen2-1.5B](https://huggingface.co/Qwen/Qwen2-1.5B) on [ReDiX/xlam-function-calling-60k-ita](https://huggingface.co/datasets/ReDiX/xlam-function-calling-60k-ita).
> [!NOTE]
> The function of this model is to perform function calling and creation of structured JSON for integration into simple and complex pipelines


## How to use

> [!WARNING]
> The model will always generate a response even if the tool does not exist and is not specified in the system prompt among the available tools. it is up to the software and the pipeline to handle erroneous output by parsing the response JSON

**System prompt (do not change)**:
```
Sei un Assistente AI che ha accesso ai seguenti tools:

{TOOL DEFINITIONS} 

Genera in formato JSON la chiamata necessaria per soddisfare la richiesta dell'utente.
{INFORMAZIONI REALTIME (es data di oggi)}
```

<details><summary>See conversation example</summary>
  
```
<|im_start|>system
Sei un Assistente AI che ha accesso ai seguenti tools:

Use the function 'stock_search' to: Get stock analisys and values
{
  "name": "stock_search",
  "description": "Get stock values",
  "parameters": {
    "ticker": {
      "param_type": "string",
      "description": "Identifier of the ticker, es: AAPL or list for multiple tickers [‘ticker1’, ‘ticker2’]“,
      "required": true
    },
    "start": {
      "param_type": "string",
      "description": "Range start date, es: 2022-01-01",
      "required": true
    },
    "end": {
      "param_type": "string",
      "description": "Range end date, es: 2022-01-01",
      "required": true
    }
  }
}
Genera in formato JSON la chiamata necessaria per soddisfare la richiesta dell'utente.
Oggi è il 2024-08-01
<|im_end|>
<|im_start|>user
Vorrei sapere com’è andata microsoft (MSFT) e tesla (TSLA) nel corso di luglio<|im_end|>
<|im_start|>assistant
```
</details>


<details><summary>Code example</summary>
    
  ```python
  import torch
from transformers import AutoModelForCausalLM, AutoTokenizer


model_id = "ReDiX/ReDiX-1.5B-JSON"
tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
model = AutoModelForCausalLM.from_pretrained(
    model_id, 
    device_map="cuda",
    trust_remote_code=True, 
    torch_dtype=torch.bfloat16
).eval()

def redix_generate(tools, prompt) -> str:
    messages = [
        { "role": "system", "content": f"Sei un Assistente AI che ha accesso ai seguenti tools:\n\n{tools}\n\nGenera in formato JSON la chiamata necessaria per soddisfare la richiesta dell'utente." },
        { "role": "user", "content": prompt }
        ]
    text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
    model_inputs = tokenizer([text], return_tensors="pt").to(model.device)

    generated_ids = model.generate(**model_inputs,max_new_tokens=256, pad_token_id=tokenizer.pad_token_id, eos_token_id=tokenizer.eos_token_id)
    generated_ids = [output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)]

    return tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]


tools = [
    {
        "name": "stock_search",
        "description": "Get stock values",
        "parameters": {
            "ticker": {
            "param_type": "string",
            "description": "Identifier of the ticker, es: AAPL or list for multiple tickers ['ticker1', 'ticker2']",
            "required": True
            },
            "start": {
            "param_type": "string",
            "description": "Range start date, es: 2022-01-01",
            "required": True
            },
            "end": {
            "param_type": "string",
            "description": "Range end date, es: 2022-01-01",
            "required": True
            }
        }
    },
    {
        "name": "lights_control",
        "description": "control house lights",
        "parameters": {
            "light_id": {
            "param_type": "string",
            "description": "Identifier of the chosen light, available are ['cucina', 'salotto', 'camera_da_letto']",
            "required": True
            },
            "status": {
            "param_type": "string",
            "description": "Can be 'On' or 'Off'",
            "required": True
            }
        }
    }
]



response = redix_generate(tools, "Accendi tutte le luci in casa")
print(response)
  ```
</details>


## Training

we trained this model on a single RTX A6000 48GB for about 5 hours

[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)