Triangle104 commited on
Commit
e9ff288
1 Parent(s): 8371ae4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +81 -0
README.md CHANGED
@@ -46,6 +46,87 @@ base_model: CohereForAI/aya-expanse-8b
46
  This model was converted to GGUF format from [`CohereForAI/aya-expanse-8b`](https://huggingface.co/CohereForAI/aya-expanse-8b) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
47
  Refer to the [original model card](https://huggingface.co/CohereForAI/aya-expanse-8b) for more details on the model.
48
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
49
  ## Use with llama.cpp
50
  Install llama.cpp through brew (works on Mac and Linux)
51
 
 
46
  This model was converted to GGUF format from [`CohereForAI/aya-expanse-8b`](https://huggingface.co/CohereForAI/aya-expanse-8b) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
47
  Refer to the [original model card](https://huggingface.co/CohereForAI/aya-expanse-8b) for more details on the model.
48
 
49
+ ---
50
+ Model details:
51
+ -
52
+ Aya Expanse 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 of models with the result of a year’s dedicated research from Cohere For AI, including data arbitrage, multilingual preference training, safety tuning, and model merging. The result is a powerful multilingual large language model serving 23 languages.
53
+
54
+ 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
55
+
56
+ This model card corresponds to the 8-billion version of the Aya Expanse model. We also released an 32-billion version which you can find here.
57
+
58
+ Developed by: Cohere For AI
59
+ Point of Contact: Cohere For AI: cohere.for.ai
60
+ License: CC-BY-NC, requires also adhering to C4AI's Acceptable Use Policy
61
+ Model: Aya Expanse 8B
62
+ Model Size: 8 billion parameters
63
+
64
+ Try Aya Expanse
65
+ -
66
+ Before downloading the weights, you can try out Aya Expanse in our hosted Hugging Face Space.
67
+
68
+ Usage
69
+ -
70
+ Please install transformers from the source repository.
71
+
72
+ # pip install 'git+https://github.com/huggingface/transformers.git'
73
+ from transformers import AutoTokenizer, AutoModelForCausalLM
74
+
75
+ model_id = "CohereForAI/aya-expanse-8b"
76
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
77
+ model = AutoModelForCausalLM.from_pretrained(model_id)
78
+
79
+ # Format the message with the chat template
80
+ messages = [{"role": "user", "content": "Anneme onu ne kadar sevdiğimi anlatan bir mektup yaz"}]
81
+ input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt")
82
+ ## <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|>
83
+
84
+ gen_tokens = model.generate(
85
+ input_ids,
86
+ max_new_tokens=100,
87
+ do_sample=True,
88
+ temperature=0.3,
89
+ )
90
+
91
+ gen_text = tokenizer.decode(gen_tokens[0])
92
+ print(gen_text)
93
+
94
+ Example Notebooks
95
+ -
96
+ Fine-Tuning:
97
+ -
98
+ This notebook showcases a detailed use of fine-tuning Aya Expanse on more languages.
99
+
100
+ Example Use cases:
101
+ -
102
+ The following notebooks contributed by Cohere For AI Community members show how Aya Expanse can be used for different use cases:
103
+
104
+ Mulitlingual Writing Assistant
105
+ AyaMCooking
106
+ Multilingual Question-Answering System
107
+
108
+ Model Details
109
+ -
110
+ Input: Models input text only.
111
+
112
+ Output: Models generate text only.
113
+
114
+ 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.
115
+
116
+ 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
117
+
118
+ Context length: 8K
119
+
120
+ Model Card Contact
121
+ -
122
+ For errors or additional questions about details in this model card, contact [email protected].
123
+
124
+ Terms of Use
125
+ -
126
+ 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 License with an acceptable use addendum, and also requires adhering to C4AI's Acceptable Use Policy.
127
+ Try the model today
128
+
129
+ ---
130
  ## Use with llama.cpp
131
  Install llama.cpp through brew (works on Mac and Linux)
132