Update README.md
Browse files
README.md
CHANGED
@@ -1,199 +1,112 @@
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
|
18 |
-
|
19 |
-
|
20 |
-
-
|
21 |
-
|
22 |
-
|
23 |
-
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
|
28 |
-
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
-
|
33 |
-
-
|
34 |
-
|
35 |
-
|
36 |
-
|
37 |
-
|
38 |
-
|
39 |
-
|
40 |
-
|
41 |
-
|
42 |
-
|
43 |
-
|
44 |
-
|
45 |
-
|
46 |
-
|
47 |
-
|
48 |
-
|
49 |
-
|
50 |
-
|
51 |
-
|
52 |
-
|
53 |
-
|
54 |
-
|
55 |
-
|
56 |
-
|
57 |
-
|
58 |
-
|
59 |
-
|
60 |
-
|
61 |
-
|
62 |
-
|
63 |
-
|
64 |
-
|
65 |
-
|
66 |
-
|
67 |
-
|
68 |
-
|
69 |
-
|
70 |
-
|
71 |
-
|
72 |
-
|
73 |
-
|
74 |
-
|
75 |
-
|
76 |
-
|
77 |
-
|
78 |
-
|
79 |
-
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
|
88 |
-
|
89 |
-
|
90 |
-
|
91 |
-
|
92 |
-
|
93 |
-
|
94 |
-
|
95 |
-
|
96 |
-
|
97 |
-
|
98 |
-
|
99 |
-
|
100 |
-
|
101 |
-
|
102 |
-
|
103 |
-
|
104 |
-
|
105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
106 |
-
|
107 |
-
### Testing Data, Factors & Metrics
|
108 |
-
|
109 |
-
#### Testing Data
|
110 |
-
|
111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Factors
|
116 |
-
|
117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Metrics
|
122 |
-
|
123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
### Results
|
128 |
-
|
129 |
-
[More Information Needed]
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
## Environmental Impact
|
142 |
-
|
143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
144 |
-
|
145 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
146 |
-
|
147 |
-
- **Hardware Type:** [More Information Needed]
|
148 |
-
- **Hours used:** [More Information Needed]
|
149 |
-
- **Cloud Provider:** [More Information Needed]
|
150 |
-
- **Compute Region:** [More Information Needed]
|
151 |
-
- **Carbon Emitted:** [More Information Needed]
|
152 |
-
|
153 |
-
## Technical Specifications [optional]
|
154 |
-
|
155 |
-
### Model Architecture and Objective
|
156 |
-
|
157 |
-
[More Information Needed]
|
158 |
-
|
159 |
-
### Compute Infrastructure
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
#### Hardware
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
#### Software
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
## Citation [optional]
|
172 |
-
|
173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
174 |
-
|
175 |
-
**BibTeX:**
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
**APA:**
|
180 |
-
|
181 |
-
[More Information Needed]
|
182 |
-
|
183 |
-
## Glossary [optional]
|
184 |
-
|
185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
## More Information [optional]
|
190 |
-
|
191 |
-
[More Information Needed]
|
192 |
-
|
193 |
-
## Model Card Authors [optional]
|
194 |
-
|
195 |
-
[More Information Needed]
|
196 |
-
|
197 |
-
## Model Card Contact
|
198 |
-
|
199 |
-
[More Information Needed]
|
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
+
license: mit
|
4 |
+
language:
|
5 |
+
- fr
|
6 |
+
- en
|
7 |
+
tags:
|
8 |
+
- french
|
9 |
+
- chocolatine
|
10 |
+
datasets:
|
11 |
+
- jpacifico/french-orca-dpo-pairs-revised
|
12 |
+
pipeline_tag: text-generation
|
13 |
---
|
14 |
|
15 |
+
### Chocolatine-14B-Instruct-DPO-v1.1
|
16 |
+
|
17 |
+
DPO fine-tuned of [microsoft/Phi-3-medium-4k-instruct](https://huggingface.co/microsoft/Phi-3-medium-4k-instruct) (14B params)
|
18 |
+
using the [jpacifico/french-orca-dpo-pairs-revised](https://huggingface.co/datasets/jpacifico/french-orca-dpo-pairs-revised) rlhf dataset.
|
19 |
+
Training in French also improves the model in English, surpassing the performances of its base model.
|
20 |
+
Window context = 4k tokens
|
21 |
+
|
22 |
+
### Benchmarks
|
23 |
+
|
24 |
+
The first Chocolatine-14B version is already the best-performing < 50B model in terms of MMLU-PRO on the [OpenLLM Leaderboard](https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard) (august 2024)
|
25 |
+
This new version 1.1 is also submitted, results coming soon.
|
26 |
+
|
27 |
+
### MT-Bench
|
28 |
+
|
29 |
+
Chocolatine-14B-Instruct-DPO-v1.1 is outperforming Phi-3-medium-4k-instruct and its previous version.
|
30 |
+
And also this v1.1 is pretty close from GPT-4o-mini (first turn is amazing!).
|
31 |
+
|
32 |
+
```
|
33 |
+
########## First turn ##########
|
34 |
+
score
|
35 |
+
model turn
|
36 |
+
Chocolatine-14B-Instruct-DPO-v1.1 1 9.1375
|
37 |
+
gpt-4o-mini 1 9.1375
|
38 |
+
Chocolatine-14B-Instruct-4k-DPO 1 8.7250
|
39 |
+
Phi-3-medium-4k-instruct 1 8.7125
|
40 |
+
Chocolatine-3B-Instruct-DPO-Revised 1 8.4625
|
41 |
+
Phi-3-mini-4k-instruct 1 8.4125
|
42 |
+
gpt-3.5-turbo 1 8.2750
|
43 |
+
|
44 |
+
########## Second turn ##########
|
45 |
+
score
|
46 |
+
model turn
|
47 |
+
gpt-4o-mini 2 9.05000
|
48 |
+
gpt-3.5-turbo 2 8.20625
|
49 |
+
Chocolatine-14B-Instruct-DPO-v1.1 2 8.18750
|
50 |
+
Chocolatine-14B-Instruct-4k-DPO 2 8.15000
|
51 |
+
Phi-3-medium-4k-instruct 2 7.92500
|
52 |
+
Chocolatine-3B-Instruct-DPO-Revised 2 7.61250
|
53 |
+
Phi-3-mini-4k-instruct 2 7.38750
|
54 |
+
|
55 |
+
########## Average ##########
|
56 |
+
score
|
57 |
+
model
|
58 |
+
gpt-4o-mini 9.093750
|
59 |
+
Chocolatine-14B-Instruct-DPO-v1.1 8.662500
|
60 |
+
Chocolatine-14B-Instruct-4k-DPO 8.437500
|
61 |
+
Phi-3-medium-4k-instruct 8.318750
|
62 |
+
gpt-3.5-turbo 8.240625
|
63 |
+
Chocolatine-3B-Instruct-DPO-Revised 8.037500
|
64 |
+
Phi-3-mini-4k-instruct 7.900000
|
65 |
+
```
|
66 |
+
|
67 |
+
### Usage
|
68 |
+
|
69 |
+
You can run this model using my [Colab notebook](https://github.com/jpacifico/Chocolatine-LLM/blob/main/Chocolatine_14B_inference_test_colab.ipynb)
|
70 |
+
|
71 |
+
You can also run Chocolatine using the following code:
|
72 |
+
|
73 |
+
```python
|
74 |
+
import transformers
|
75 |
+
from transformers import AutoTokenizer
|
76 |
+
|
77 |
+
# Format prompt
|
78 |
+
message = [
|
79 |
+
{"role": "system", "content": "You are a helpful assistant chatbot."},
|
80 |
+
{"role": "user", "content": "What is a Large Language Model?"}
|
81 |
+
]
|
82 |
+
tokenizer = AutoTokenizer.from_pretrained(new_model)
|
83 |
+
prompt = tokenizer.apply_chat_template(message, add_generation_prompt=True, tokenize=False)
|
84 |
+
|
85 |
+
# Create pipeline
|
86 |
+
pipeline = transformers.pipeline(
|
87 |
+
"text-generation",
|
88 |
+
model=new_model,
|
89 |
+
tokenizer=tokenizer
|
90 |
+
)
|
91 |
+
|
92 |
+
# Generate text
|
93 |
+
sequences = pipeline(
|
94 |
+
prompt,
|
95 |
+
do_sample=True,
|
96 |
+
temperature=0.7,
|
97 |
+
top_p=0.9,
|
98 |
+
num_return_sequences=1,
|
99 |
+
max_length=200,
|
100 |
+
)
|
101 |
+
print(sequences[0]['generated_text'])
|
102 |
+
```
|
103 |
+
|
104 |
+
### Limitations
|
105 |
+
|
106 |
+
The Chocolatine model is a quick demonstration that a base model can be easily fine-tuned to achieve compelling performance.
|
107 |
+
It does not have any moderation mechanism.
|
108 |
+
|
109 |
+
- **Developed by:** Jonathan Pacifico, 2024
|
110 |
+
- **Model type:** LLM
|
111 |
+
- **Language(s) (NLP):** French, English
|
112 |
+
- **License:** MIT
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|