README.md

---
license: apache-2.0
---
<style>
table {
    border-collapse: collapse;
    width: 100%;
    margin-bottom: 20px;
}
th, td {
    border: 1px solid #ddd;
    padding: 8px;
    text-align: center;
}
.best {
    font-weight: bold;
    text-decoration: underline;
}
</style>

<div style="text-align: center; margin: 20px auto; padding: 20px; border: 3px solid #ddd; border-radius: 10px;">
  <h2 style="margin-bottom: 4px; margin-top: 0px;">OuteAI</h2>
  <a href="https://www.outeai.com/" target="_blank" style="margin-right: 10px;">🌎 OuteAI.com</a> 
  <a href="https://discord.gg/vyBM87kAmf" target="_blank" style="margin-right: 10px;">🤝 Join our Discord</a>
  <a href="https://x.com/OuteAI" target="_blank">𝕏 @OuteAI</a>
</div>

# Lite-Mistral-150M-v2-Instruct

This is a Lite series model based on the Mistral architecture, comprising approximately 157 million parameters. <br>
The primary goal of this 150 million parameter model was to develop a compact and efficient model capable of operating on a wide range of devices, while maintaining a reasonable level of functionality and coherence for its small size. A smaller model scale may lead to challenges in preserving context over multi-turn conversations. Consequently, there is a risk of inconsistent or inaccurate responses. <br>

The model was trained on ~8 billion tokens.

<a href="https://huggingface.co/OuteAI/Lite-Mistral-150M-v2-Instruct">Lite-Mistral-150M-v2-Instruct</a> <br>
<a href="https://huggingface.co/OuteAI/Lite-Mistral-150M-v2-Instruct-GGUF">Lite-Mistral-150M-v2-Instruct-GGUF</a> <br>


## Improvements from v1:
- Extended Training: Further refinement of the model, resulting in improved benchmark performance and overall text generation quality.
- Tokenizer changes.

## Chat format

> [!IMPORTANT]
> This model is **sensitive** to the chat template used. Ensure you use the correct template:
```
<s>system
[System message]</s>
<s>user
[Your question or message]</s> 
<s>assistant
[The model's response]</s>
```

## How coherent is the 150M model?
Let's look at real-world examples:

<details open> 
  <summary>Example 1</summary>
  
  ```
  <s>user
  What is the capital of France?</s> 
  <s>assistant
  The capital of France is Paris.</s> 
  <s>user
  What is the capital of Spain?</s>
  <s>assistant
  The capital of Spain is Madrid, which is known for its beautiful architecture and rich history.</s>
  ```

</details>

<details open> 
  <summary>Example 2</summary>

  ```
  <s>user
  Who wrote the play "Romeo and Juliet"?</s>
  <s>assistant
  The play "Romeo and Juliet" was written by William Shakespeare.</s>
  ```

</details>

<details> 
  <summary>Example 3</summary>

  ```
  <s>system
  You are a helpful assistant.</s>
  <s>user
  I'd like to learn about language models. Can you break down the concept for me?</s>
  <s>assistant
  Of course! Language models are computer programs designed to mimic human language, which is the way humans understand and interact with each other.
  They use algorithms to analyze data and generate responses that are similar to how humans do on their own.</s>
  ```

</details>

<details> 
  <summary>Example 4 (RP)</summary>

  ```
  [Input for the model]
  <s>user
  Let's roleplay. I'll be a customer at a restaurant, and you be the waiter. Ready?</s> 
  <s>assistant
  Certainly! I'll play the role of a waiter. Please go ahead and start the roleplay when you're ready.</s> 
  <s>user
  Hello, I'd like to see the menu please.</s> 
  <s>assistant
  Good evening, sir! Welcome to our restaurant. Here's our menu for today. May I recommend our chef's special, the grilled salmon with lemon butter sauce? Let me know if you have any questions about our dishes.</s> 
  <s>user
  I'll have the salmon. What wines do you recommend to go with it?</s> 
  
  [Model's response]
  <s> assistant
  To go with your salmon, we suggest a pair of red-tailed or white-tailed jackfights. The grilled salmon is creamy and has a nice acidity. The lemon butter sauce is a great addition to this dish.</s>
  ```

</details>

The model shows some promise in understanding context related to simple requests, but it's clear that it still struggles with more complex or nuanced situations.

## Benchmarks:

<table style="text-align: left;">
  <tr>
    <th>Benchmark</th>
    <th>5-shot (acc)</th>
    <th>5-shot (acc_norm)</th>
    <th>0-shot (acc)</th>
    <th>0-shot (acc_norm)</th>
  </tr>
  <tr>
    <td>ARC Easy</td>
    <td>47.26</td>
    <td>46.30</td>
    <td>45.58</td>
    <td>39.52</td>
  </tr>
  <tr>
    <td>BoolQ</td>
    <td>43.33</td>
    <td>-</td>
    <td>44.16</td>
    <td>-</td>
  </tr>
  <tr>
    <td>HellaSWAG</td>
    <td>28.70</td>
    <td>30.73</td>
    <td>28.72</td>
    <td>31.01</td>
  </tr>
  <tr>
    <td>MMLU</td>
    <td>-</td>
    <td>-</td>
    <td>25.28</td>
    <td>-</td>
  </tr>
  <tr>
    <td>OpenBookQA</td>
    <td>16.00</td>
    <td>28.00</td>
    <td>18.20</td>
    <td>28.40</td>
  </tr>
  <tr>
    <td>PIQA</td>
    <td>62.79</td>
    <td>62.68</td>
    <td>62.02</td>
    <td>60.23</td>
  </tr>
  <tr>
    <td>Winogrande</td>
    <td>51.30</td>
    <td>-</td>
    <td>51.78</td>
    <td>-</td>
  </tr>
</table>

## Usage with HuggingFace transformers 
The model can be used with HuggingFace's `transformers` library:
```python
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

device = torch.device("cuda" if torch.cuda.is_available() else "cpu")

model = AutoModelForCausalLM.from_pretrained("OuteAI/Lite-Mistral-150M-v2-Instruct").to(device)
tokenizer = AutoTokenizer.from_pretrained("OuteAI/Lite-Mistral-150M-v2-Instruct")

def generate_response(message: str, temperature: float = 0.4, repetition_penalty: float = 1.1) -> str:
    # Apply the chat template and convert to PyTorch tensors
    messages = [
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": message}
    ]
    input_ids = tokenizer.apply_chat_template(
        messages, add_generation_prompt=True, return_tensors="pt"
    ).to(device)

    # Generate the response
    output = model.generate(
        input_ids,
        max_length=512,
        temperature=temperature,
        repetition_penalty=repetition_penalty,
        do_sample=True
    ) 

    # Decode the generated output
    generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
    return generated_text

message = "I'd like to learn about language models. Can you break down the concept for me?"
response = generate_response(message)
print(response)
```

## Risk Disclaimer

By using this model, you acknowledge that you understand and assume the risks associated with its use. 
You are solely responsible for ensuring compliance with all applicable laws and regulations. 
We disclaim any liability for problems arising from the use of this open-source model, including but not limited to direct, indirect, incidental, consequential, or punitive damages. 
We make no warranties, express or implied, regarding the model's performance, accuracy, or fitness for a particular purpose. Your use of this model is at your own risk, and you agree to hold harmless and indemnify us, our affiliates, and our contributors from any claims, damages, or expenses arising from your use of the model.