Update README.md

README.md

@@ -9,14 +9,80 @@ tags:
 license: apache-2.0
 language:
 - en
+- ur
 ---
 
-# Uploaded  model
+
+# Model Card for Alif Llama 3.1 8B Instruct
+
+<img src="aya-expanse-8B.png" width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+
+**Alif Llama 3.1 8B Instruct** is an open-weight research release of a model with highly advanced multilingual capabilities. It focuses on pairing a highly performant pre-trained [Command family](https://huggingface.co/CohereForAI/c4ai-command-r-plus) of models with the result of a year’s dedicated research from [Cohere For AI](https://cohere.for.ai/), including [data arbitrage](https://arxiv.org/abs/2408.14960), [multilingual preference training](https://arxiv.org/abs/2407.02552), [safety tuning](https://arxiv.org/abs/2406.18682), and [model merging](https://arxiv.org/abs/2410.10801). The result is a powerful multilingual large language model.
+
 
 - **Developed by:** large-traversaal
 - **License:** apache-2.0
 - **Finetuned from model :** unsloth/Meta-Llama-3.1-8B
+- **Model:** Alif Llama 3.1 8B Instruct
+- **Model Size:** 8 billion parameters
 
 This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
 
 [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+
+
+
+### How to Use Alif Llama
+
+Install the transformers library and load Alif Llama 3.1 8B Instruct as follows:
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+model_id = "CohereForAI/aya-expanse-8b"
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(model_id)
+
+# Format the message with the chat template
+messages = [{"role": "user", "content": "Anneme onu ne kadar sevdiğimi anlatan bir mektup yaz"}]
+input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt")
+## <BOS_TOKEN><|START_OF_TURN_TOKEN|><|USER_TOKEN|>Anneme onu ne kadar sevdiğimi anlatan bir mektup yaz<|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|CHATBOT_TOKEN|>
+
+gen_tokens = model.generate(
+    input_ids, 
+    max_new_tokens=100, 
+    do_sample=True, 
+    temperature=0.3,
+    )
+
+gen_text = tokenizer.decode(gen_tokens[0])
+print(gen_text)
+```
+
+
+## Model Details
+
+**Input**: Models input text only.
+
+**Output**: Models generate text only.
+
+**Model Architecture**: Aya Expanse 8B is an auto-regressive language model that uses an optimized transformer architecture. Post-training includes supervised finetuning, preference training, and model merging.
+
+For more details about how the model was trained, check out [our blogpost](https://huggingface.co/blog/aya-expanse).
+
+### Evaluation
+
+We evaluated Aya Expanse 8B against Gemma 2 9B, Llama 3.1 8B, Ministral 8B, and Qwen 2.5 7B using the `dolly_human_edited` subset from the [Aya Evaluation Suite dataset](https://huggingface.co/datasets/CohereForAI/aya_evaluation_suite) and m-ArenaHard, a dataset based on the [Arena-Hard-Auto dataset](https://huggingface.co/datasets/lmarena-ai/arena-hard-auto-v0.1) and translated to the 23 languages we support in Aya Expanse 8B. Win-rates were determined using gpt-4o-2024-08-06 as a judge. For a conservative benchmark, we report results from gpt-4o-2024-08-06, though gpt-4o-mini scores showed even stronger performance.
+
+The m-ArenaHard dataset, used to evaluate Aya Expanse’s capabilities, is publicly available [here](https://huggingface.co/datasets/CohereForAI/m-ArenaHard).
+
+<img src="winrates_marenahard_complete.png" width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+<img src="winrates_dolly.png" width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+<img src="winrates_by_lang.png"  width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+<img src="winrates_step_by_step.png"  width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+
+
+### Model Card Contact
+
+For errors or additional questions about details in this model card, contact [email protected].
+