# 🌟 Falcon-RW-1B-Chat

**Falcon-RW-1B-Chat is a conversational model with 1 billion parameters.** It's a further refinement of the [Falcon-RW-1B-Instruct-OpenOrca](https://huggingface.co/ericzzz/falcon-rw-1b-instruct-openorca), trained on selected data from the [HuggingFaceH4/ultrachat_200k](https://huggingface.co/datasets/HuggingFaceH4/ultrachat_200k) and [openchat/openchat_sharegpt4_dataset](https://huggingface.co/datasets/openchat/openchat_sharegpt4_dataset) datasets.

**✨Try it out at our [Tiny Chat](https://huggingface.co/spaces/ericzzz/tiny-chat) space running on free-tier hardware!✨**

The underlying Falcon-RW-1B-Instruct-OpenOrca model is built on the [Falcon-RW-1B](https://huggingface.co/tiiuae/falcon-rw-1b), a causal decoder-only model. It has been instruction-finetuned using the [Open-Orca/SlimOrca](https://huggingface.co/datasets/Open-Orca/SlimOrca) dataset.

**📊 Evaluation Results**

Detailed results can be found [here](https://huggingface.co/datasets/open-llm-leaderboard/details_ericzzz__falcon-rw-1b-chat).

| Metric      | Falcon-RW-1b-Chat         | Falcon-RW-1b        |
|-------------|---------------------------|---------------------|
| ARC         | 35.58                     | 35.07               |
| HellaSwag   | 61.12                     | 63.56               |
| MMLU        | 24.51                     | 25.28               |
| TruthfulQA  | 39.62                     | 35.96               |
| Winogrande  | 61.72                     | 62.04               |
| GSM8K       | 1.67                      | 0.53                |
| **Average** | **37.37**                 | **37.07**           |

**🎯 Purpose**

The Falcon-RW-1B-Chat aims to add conversational capabilities to the Falcon-RW-1B-Instruct-OpenOrca model. This initiative is driven by the need for a smaller, open-source, instruction-finetuned, ready-to-use model, suitable for users with limited computational resources, like lower-end consumer GPUs.

## 📖 Example Code

```python
from transformers import AutoTokenizer, AutoModelForCausalLM
import torch

model_name = "ericzzz/falcon-rw-1b-chat"

tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForCausalLM.from_pretrained(
    model_name, device_map="auto", torch_dtype=torch.bfloat16
)

chat_history = [
    {"role": "user", "content": "Hello!"},
    {"role": "assistant", "content": "Hello! How can I assist you today?"},
    {"role": "user", "content": "Explain what AI is."},
]

input_ids = tokenizer.apply_chat_template(
    chat_history, tokenize=True, add_generation_prompt=True, return_tensors="pt"
).to(model.device)
output_tokens = model.generate(
    input_ids,
    do_sample=True,
    temperature=0.7,
    repetition_penalty=1.05,
    max_new_tokens=200,
)
output_text = tokenizer.decode(
    output_tokens[0][len(input_ids[0]) :], skip_special_tokens=True
)

print(output_text)
```

## ⚠️ Limitations

This model may generate inaccurate or misleading information and is prone to hallucination, creating plausible but false narratives. It lacks the ability to discern factual content from fiction and may inadvertently produce biased, harmful or offensive content. Its understanding of complex, nuanced queries is limited. Users should be aware of this and verify any information obtained from the model.

The model is provided 'as is' without any warranties, and the creators are not liable for any damages arising from its use. Users are responsible for their interactions with the model.

## 📬 Contact

For further inquiries or feedback, please contact at eric.fu96@aol.com.
{"language": ["en"], "license": "apache-2.0", "tags": ["text-generation-inference"], "datasets": ["HuggingFaceH4/ultrachat_200k", "openchat/openchat_sharegpt4_dataset", "Open-Orca/SlimOrca"], "pipeline_tag": "conversational", "inference": false}
transformers safetensors falcon text-generation text-generation-inference conversational en dataset:HuggingFaceH4/ultrachat_200k dataset:openchat/openchat_sharegpt4_dataset dataset:Open-Orca/SlimOrca license:apache-2.0 autotrain_compatible has_space region:us