iperbole commited on
Commit
90acc74
·
verified ·
1 Parent(s): ebe335f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +78 -160
README.md CHANGED
@@ -3,197 +3,115 @@ library_name: transformers
3
  tags: []
4
  ---
5
 
6
- # Model Card for Model ID
 
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
 
 
 
 
 
35
 
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
 
103
  ## Evaluation
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]
 
 
 
 
 
 
 
 
 
 
 
3
  tags: []
4
  ---
5
 
6
+ # Mistral-7B-v0.1-Italian-SAVA-instruct
7
+ <div align="center">
8
 
9
+ <img src="https://github.com/Andrew-Wyn/images/blob/master/sava/italian_adapt-img.jpg?raw=true" width="400" height="400" style="border-radius:10%" />
10
 
11
+ </div>
12
 
13
+ The **Mistral-7B-v0.1-Adapted** collection of large language models (LLMs), is a collection of adapted generative models in 7B (text in/text out), adapted models from **Mistral-7B-Base-v0.1**.
14
 
15
+ *Mistral-v0.1-Italian-SAVA-instruct* is a continually trained and instruction tuned Mistral model.
16
 
17
+ **Model developer:** SapienzaNLP, ISTI-CNR, ILC-CNR
18
 
19
+ **Model Architecture:** Mistral-7B-v0.1-Adapted is an auto-regressive language model that uses an optimized transformer architecture.
20
 
21
+ ## Data used for the adaptation
22
 
23
+ The **Mistral-7B-v0.1-Adapted** models are trained on a collection of Italian and English data extracted from [CulturaX](https://huggingface.co/datasets/uonlp/CulturaX).
24
+ The data are extracted to be skewed toward Italian language with a ration of one over four. Extracting the first 9B tokens from Italian part of CulturaX and the first 3B tokens from English part of CulturaX.
 
 
 
 
 
25
 
26
+ ## Data used for the instruction tuning (SFT)
27
 
28
+ The data used in the instruction following training procedure:
29
 
30
+ | Dataset | Language | Instances |
31
+ |------|-----|------|
32
+ | [TÜLU-v3](https://huggingface.co/datasets/allenai/tulu-3-sft-mixture) | EN | 940,000 |
33
+ | [LIMA](https://huggingface.co/datasets/GAIR/lima) | IT/EN | 2,000 |
34
+ | [WildChat-IT](https://huggingface.co/datasets/allenai/WildChat-1M) | IT | 5,000 |
35
+ | [TowerBlocks-v0.2](https://huggingface.co/datasets/Unbabel/TowerBlocks-v0.2) | IT/EN | 7,276 |
36
+ | [GPT-4o-ITA-Instruct](https://huggingface.co/datasets/DeepMount00/GPT-4o-ITA-INSTRUCT) | IT | 15,000 |
37
+ | [Aya](https://huggingface.co/datasets/CohereLabs/aya_dataset) | IT | 700 |
38
 
39
+ The model is trained for two epoches in the aforementioned data.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
 
41
  ## Evaluation
42
 
43
+ Adapted models are evaluated on [ITA-Bench](https://github.com/SapienzaNLP/ita-bench).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
44
 
45
+ | Model | MMLU (5-shots) | ARC-C (5-shots) | Hellaswag (0-shots) | IFEval (inst_level) |
46
+ |------|-----|------|------|------|
47
+ | Llama-3.1-SAVA | 56.9 | 42.3 | 58.1 | 62.3 |
48
+ | Llama-3.1-LAPT | 58.5 | 47.9 | 62.4 | 67.3 |
49
+ | **Mistral-0.1-SAVA** | 51.5 | 41.6 | 57.5 | 61.7 |
50
+ | Mistral-0.1-LAPT | 52.9 | 39.9 | 58.4 | 60.0 |
51
+ | Llama-3.1-Original | 47.4 | 43.1 | 57.9 | 66.8 |
52
+ | Mistral-0.1-Original | 41.6 | 38.9 | 50.0 | 42.2 |
53
 
54
+ ## Use with Transformers
55
 
56
+ You can run conversational inference using the Transformers pipeline abstraction or by leveraging the Auto classes with the generate() function.
57
 
58
+ Make sure to update your transformers installation via `pip install --upgrade transformers`.
59
 
60
+ ```python
61
+ import transformers
62
+ import torch
63
 
64
+ model_id = "SemanticAlignment/Mistral-v0.1-Italian-SAVA-instruct"
65
 
66
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
67
 
68
+ generator = pipeline(
69
+ "text-generation",
70
+ model=model_name,
71
+ device_map="auto",
72
+ dtype=torch.bfloat16
73
+ )
74
 
75
+ conversations.append([
76
+ {"role": "system", "content": "Sei un assistente utile, rispondi in modo conciso e coerente."},
77
+ {"role": "user", "content": "Cosa si può fare in una bella giornata di sole?"},
78
+ ])
79
 
80
+ chat_samples = tokenizer.apply_chat_template(conversations, tokenize=False)
81
 
82
+ # get number of prompt tokens
83
+ prompt_tokens_number = len(tokenizer(chat_samples)["input_ids"])
84
 
85
+ outputs = generator(
86
+ conversations,
87
+ max_new_tokens=2048,
88
+ eos_token_id=[
89
+ tokenizer.eos_token_id,
90
+ tokenizer.convert_tokens_to_ids("<|eot_id|>"),
91
+ ],
92
+ )
93
 
94
+ ```
95
 
96
+ Code: https://github.com/SapienzaNLP/sava
97
 
98
+ ## Aknowledgement
99
+ Thanks to Leonardo Colosi (colosi@diag.uniroma1.it) for helping in instruction tuning phase.
100
 
101
+ We acknowledge ISCRA for awarding this project access to the LEONARDO supercomputer, owned by the EuroHPC Joint Undertaking, hosted by CINECA (Italy).
102
 
103
+ ## Citation
104
 
105
+ If you use any part of this work, please consider citing the paper as follows:
106
 
107
+ ```bibtex
108
+ @misc{moroni2025optimizingllmsitalianreducing,
109
+ title={Optimizing LLMs for Italian: Reducing Token Fertility and Enhancing Efficiency Through Vocabulary Adaptation},
110
+ author={Luca Moroni and Giovanni Puccetti and Pere-Lluis Huguet Cabot and Andrei Stefan Bejgu and Edoardo Barba and Alessio Miaschi and Felice Dell'Orletta and Andrea Esuli and Roberto Navigli},
111
+ year={2025},
112
+ eprint={2504.17025},
113
+ archivePrefix={arXiv},
114
+ primaryClass={cs.CL},
115
+ url={https://arxiv.org/abs/2504.17025},
116
+ }
117
+ ```