RichardErkhov commited on
Commit
7c29717
1 Parent(s): b37daeb

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +166 -0
README.md ADDED
@@ -0,0 +1,166 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quantization made by Richard Erkhov.
2
+
3
+ [Github](https://github.com/RichardErkhov)
4
+
5
+ [Discord](https://discord.gg/pvy7H8DZMG)
6
+
7
+ [Request more models](https://github.com/RichardErkhov/quant_request)
8
+
9
+
10
+ aya-expanse-32b-ungated - GGUF
11
+ - Model creator: https://huggingface.co/adamo1139/
12
+ - Original model: https://huggingface.co/adamo1139/aya-expanse-32b-ungated/
13
+
14
+
15
+ | Name | Quant method | Size |
16
+ | ---- | ---- | ---- |
17
+ | [aya-expanse-32b-ungated.Q2_K.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q2_K.gguf) | Q2_K | 11.93GB |
18
+ | [aya-expanse-32b-ungated.Q3_K_S.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q3_K_S.gguf) | Q3_K_S | 13.7GB |
19
+ | [aya-expanse-32b-ungated.Q3_K.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q3_K.gguf) | Q3_K | 15.12GB |
20
+ | [aya-expanse-32b-ungated.Q3_K_M.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q3_K_M.gguf) | Q3_K_M | 15.12GB |
21
+ | [aya-expanse-32b-ungated.Q3_K_L.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q3_K_L.gguf) | Q3_K_L | 16.36GB |
22
+ | [aya-expanse-32b-ungated.IQ4_XS.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.IQ4_XS.gguf) | IQ4_XS | 16.75GB |
23
+ | [aya-expanse-32b-ungated.Q4_0.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q4_0.gguf) | Q4_0 | 17.43GB |
24
+ | [aya-expanse-32b-ungated.IQ4_NL.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.IQ4_NL.gguf) | IQ4_NL | 17.59GB |
25
+ | [aya-expanse-32b-ungated.Q4_K_S.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q4_K_S.gguf) | Q4_K_S | 17.55GB |
26
+ | [aya-expanse-32b-ungated.Q4_K.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q4_K.gguf) | Q4_K | 18.44GB |
27
+ | [aya-expanse-32b-ungated.Q4_K_M.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q4_K_M.gguf) | Q4_K_M | 18.44GB |
28
+ | [aya-expanse-32b-ungated.Q4_1.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q4_1.gguf) | Q4_1 | 19.19GB |
29
+ | [aya-expanse-32b-ungated.Q5_0.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q5_0.gguf) | Q5_0 | 20.95GB |
30
+ | [aya-expanse-32b-ungated.Q5_K_S.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q5_K_S.gguf) | Q5_K_S | 20.95GB |
31
+ | [aya-expanse-32b-ungated.Q5_K.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q5_K.gguf) | Q5_K | 21.47GB |
32
+ | [aya-expanse-32b-ungated.Q5_K_M.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q5_K_M.gguf) | Q5_K_M | 21.47GB |
33
+ | [aya-expanse-32b-ungated.Q5_1.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q5_1.gguf) | Q5_1 | 22.71GB |
34
+ | [aya-expanse-32b-ungated.Q6_K.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q6_K.gguf) | Q6_K | 24.68GB |
35
+ | [aya-expanse-32b-ungated.Q8_0.gguf](https://huggingface.co/RichardErkhov/adamo1139_-_aya-expanse-32b-ungated-gguf/blob/main/aya-expanse-32b-ungated.Q8_0.gguf) | Q8_0 | 31.97GB |
36
+
37
+
38
+
39
+
40
+ Original model description:
41
+ ---
42
+ inference: false
43
+ library_name: transformers
44
+ language:
45
+ - en
46
+ - fr
47
+ - de
48
+ - es
49
+ - it
50
+ - pt
51
+ - ja
52
+ - ko
53
+ - zh
54
+ - ar
55
+ - el
56
+ - fa
57
+ - pl
58
+ - id
59
+ - cs
60
+ - he
61
+ - hi
62
+ - nl
63
+ - ro
64
+ - ru
65
+ - tr
66
+ - uk
67
+ - vi
68
+ license: cc-by-nc-4.0
69
+ ---
70
+
71
+ # Model Card for Aya-Expanse-32B Ungated
72
+
73
+ Aya-Expanse 32B, but not gated!
74
+
75
+ <img src="aya-expanse-32B.png" width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
76
+
77
+ **Aya Expanse 32B** 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/pdf/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 serving 23 languages.
78
+
79
+ This model card corresponds to the 32-billion version of the Aya Expanse model. We also released an 8-billion version which you can find [here](https://huggingface.co/CohereForAI/aya-expanse-8B).
80
+
81
+ - Developed by: [Cohere For AI](https://cohere.for.ai/)
82
+ - Point of Contact: Cohere For AI: [cohere.for.ai](https://cohere.for.ai/)
83
+ - License: [CC-BY-NC](https://cohere.com/c4ai-cc-by-nc-license), requires also adhering to [C4AI's Acceptable Use Policy](https://docs.cohere.com/docs/c4ai-acceptable-use-policy)
84
+ - Model: Aya Expanse 32B
85
+ - Model Size: 32 billion parameters
86
+
87
+ ### Supported Languages
88
+
89
+ We cover 23 languages: Arabic, Chinese (simplified & traditional), Czech, Dutch, English, French, German, Greek, Hebrew, Hebrew, Hindi, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Turkish, Ukrainian, and Vietnamese.
90
+
91
+ ### Try it: Aya Expanse in Action
92
+
93
+ Use the [Cohere playground](https://dashboard.cohere.com/playground/chat) or our [Hugging Face Space](https://huggingface.co/spaces/CohereForAI/aya_expanse) for interactive exploration.
94
+
95
+
96
+ ### How to Use Aya Expanse
97
+
98
+ Install the transformers library and load Aya Expanse 32B as follows:
99
+
100
+ ```python
101
+ from transformers import AutoTokenizer, AutoModelForCausalLM
102
+
103
+ model_id = "CohereForAI/aya-expanse-32b"
104
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
105
+ model = AutoModelForCausalLM.from_pretrained(model_id)
106
+
107
+ # Format message with the chat template
108
+ messages = [{"role": "user", "content": "Anneme onu ne kadar sevdiğimi anlatan bir mektup yaz"}]
109
+ input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt")
110
+ ## <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|>
111
+
112
+ gen_tokens = model.generate(
113
+ input_ids,
114
+ max_new_tokens=100,
115
+ do_sample=True,
116
+ temperature=0.3,
117
+ )
118
+
119
+ gen_text = tokenizer.decode(gen_tokens[0])
120
+ print(gen_text)
121
+ ```
122
+
123
+ ### Example Notebooks
124
+
125
+ **Fine-Tuning:**
126
+ - [Detailed Fine-Tuning Notebook](https://colab.research.google.com/drive/1ryPYXzqb7oIn2fchMLdCNSIH5KfyEtv4).
127
+
128
+ **Community-Contributed Use Cases:**:
129
+
130
+ The following notebooks contributed by *Cohere For AI Community* members show how Aya Expanse can be used for different use cases:
131
+ - [Mulitlingual Writing Assistant](https://colab.research.google.com/drive/1SRLWQ0HdYN_NbRMVVUHTDXb-LSMZWF60)
132
+ - [AyaMCooking](https://colab.research.google.com/drive/1-cnn4LXYoZ4ARBpnsjQM3sU7egOL_fLB?usp=sharing)
133
+ - [Multilingual Question-Answering System](https://colab.research.google.com/drive/1bbB8hzyzCJbfMVjsZPeh4yNEALJFGNQy?usp=sharing)
134
+
135
+
136
+ ## Model Details
137
+
138
+ **Input**: Models input text only.
139
+
140
+ **Output**: Models generate text only.
141
+
142
+ **Model Architecture**: Aya Expanse 32B is an auto-regressive language model that uses an optimized transformer architecture. Post-training includes supervised finetuning, preference training, and model merging.
143
+
144
+ **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
145
+
146
+ **Context length**: 128K
147
+
148
+ ### Evaluation
149
+
150
+ We evaluated Aya Expanse 8B against Gemma 2 9B, Llama 3.1 8B, Ministral 8B, and Qwen 2.5 7B using 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.
151
+
152
+ The m-ArenaHard dataset, used to evaluate Aya Expanse’s capabilities, is publicly available [here](https://huggingface.co/datasets/CohereForAI/m-ArenaHard).
153
+
154
+
155
+ <img src="winrates_marenahard_complete.png" width="650" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
156
+
157
+
158
+ ### Model Card Contact
159
+
160
+ For errors or additional questions about details in this model card, contact info@for.ai.
161
+
162
+ ### Terms of Use
163
+
164
+ We hope that the release of this model will make community-based research efforts more accessible, by releasing the weights of a highly performant multilingual model to researchers all over the world. This model is governed by a [CC-BY-NC](https://cohere.com/c4ai-cc-by-nc-license) License with an acceptable use addendum, and also requires adhering to [C4AI's Acceptable Use Policy](https://docs.cohere.com/docs/c4ai-acceptable-use-policy).
165
+
166
+