Create README.md

README.md

@@ -0,0 +1,115 @@
+---
+language:
+- en
+- fr
+- de
+- es
+- it
+- pt
+- ja
+- ko
+- zh
+- ar
+- el
+- fa
+- pl
+- id
+- cs
+- he
+- hi
+- nl
+- ro
+- ru
+- tr
+- uk
+- vi
+license: cc-by-nc-4.0
+tags:
+- multilingual
+- instruction-tuning
+- awq
+model_name: Aya-23-8B
+base_model: CohereForAI/aya-23-8B
+inference: false
+model_creator: Cohere For AI
+model_type: transformer
+quantized_by: alijawad07
+---
+# Aya-23-8B - AWQ Quantized
+- Model creator: [Cohere For AI](https://huggingface.co/cohere-for-ai)
+- Original model: [Aya-23-8B](https://huggingface.co/CohereForAI/aya-23-8B)
+
+<!-- description start -->
+## Description
+
+This repo contains AWQ model files for [Cohere's Aya-23-8B](https://huggingface.co/CohereForAI/aya-23-8B).
+
+Aya 23 is an open weights research release of an instruction fine-tuned model with highly advanced multilingual capabilities. The model focuses on pairing a highly performant pre-trained Command family of models with the recently released Aya Collection. The result is a powerful multilingual large language model serving 23 languages.
+
+### About AWQ
+
+AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference.
+
+It is also now supported by continuous batching server [vLLM](https://github.com/vllm-project/vllm), allowing use of AWQ models for high-throughput concurrent inference in multi-user server scenarios. Note that, at the time of writing, overall throughput is still lower than running vLLM with unquantized models. However, using AWQ enables using much smaller GPUs which can lead to easier deployment and overall cost savings. For example, a 70B model can be run on 1 x 48GB GPU instead of 2 x 80GB.
+<!-- description end -->
+
+## Model Summary
+
+Aya 23 is an open weights research release of an instruction fine-tuned model with highly advanced multilingual capabilities. Aya 23 focuses on pairing a highly performant pre-trained [Command family](https://huggingface.co/CohereForAI/c4ai-command-r-plus) of models with the recently released [Aya Collection](https://huggingface.co/datasets/CohereForAI/aya_collection). The result is a powerful multilingual large language model serving 23 languages.
+
+It covers 23 languages: Arabic, Chinese (simplified & traditional), Czech, Dutch, English, French, German, Greek, Hebrew, Hindi, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Turkish, Ukrainian, and Vietnamese.
+
+Developed by: [Cohere For AI](https://cohere.for.ai) and [Cohere](https://cohere.com/)
+
+- Model: aya-23-8B-AWQ-GEMM
+- Model Size: 8 billion parameters
+- Bits: 4
+- Q-Group Size: 128
+
+**This is an AWQ quantized version of the Aya-23-8B model using AutoAWQ.**
+
+### Usage
+
+Please install transformers from the source repository that includes the necessary changes for this model.
+
+```python
+# pip install transformers==4.41.1
+# pip install autoawq
+from transformers import AutoTokenizer
+from awq import AutoAWQForCausalLM
+
+quant_path = "path/to/quantized/model"
+
+tokenizer = AutoTokenizer.from_pretrained(quant_path)
+model = AutoAWQForCausalLM.from_quantized(quant_path, fuse_layers=True)
+
+# Format message with the command-r-plus 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>Anneme onu ne kadar sevdiğimi anlatan bir mektup yaz
+
+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-23-8B is an auto-regressive language model that uses an optimized transformer architecture. After pretraining, this model is fine-tuned (IFT) to follow human instructions.
+
+**Languages covered**: The model is particularly optimized for multilinguality and supports the following languages: Arabic, Chinese (simplified & traditional), Czech, Dutch, English, French, German, Greek, Hebrew, Hindi, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Turkish, Ukrainian, and Vietnamese
+
+**Context length**: 8192
+
+
+Please refer to the [Aya 23 technical report](https://cohere.com/research/papers/aya-command-23-8b-and-35b-technical-report-2024-05-23) for further details about the base model, data, instruction tuning, and evaluation.