RichardErkhov commited on
Commit
629bd9e
1 Parent(s): f314b83

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +200 -0
README.md ADDED
@@ -0,0 +1,200 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ bertin-gpt-j-6B-alpaca - bnb 8bits
11
+ - Model creator: https://huggingface.co/bertin-project/
12
+ - Original model: https://huggingface.co/bertin-project/bertin-gpt-j-6B-alpaca/
13
+
14
+
15
+
16
+
17
+ Original model description:
18
+ ---
19
+ license: openrail
20
+ datasets:
21
+ - bertin-project/alpaca-spanish
22
+ library_name: transformers
23
+ language:
24
+ - es
25
+ pipeline_tag: text-generation
26
+ tags:
27
+ - alpaca
28
+ - ggml
29
+ widget:
30
+ - text: >-
31
+ A continuación hay una instrucción que describe una tarea. Escribe una
32
+ respuesta que complete adecuadamente lo que se pide.
33
+
34
+ ### Instrucción: Escribe un correo electrónico dando la bienvenida a un
35
+ nuevo empleado llamado Manolo.
36
+
37
+ ### Respuesta:
38
+ example_title: E-mail
39
+ - text: >-
40
+ A continuación hay una instrucción que describe una tarea. Escribe una
41
+ respuesta que complete adecuadamente lo que se pide.
42
+
43
+ ### Instrucción: Cuéntame algo sobre las alpacas.
44
+
45
+ ### Respuesta:
46
+ example_title: Alpacas
47
+ - text: >-
48
+ A continuación hay una instrucción que describe una tarea. Escribe una
49
+ respuesta que complete adecuadamente lo que se pide.
50
+
51
+ ### Instrucción: Inventa una excusa creativa para decir que no tengo que ir
52
+ a la fiesta.
53
+
54
+ ### Respuesta:
55
+ example_title: Excusa
56
+ ---
57
+
58
+
59
+ # BERTIN-GPT-J-6B Alpaca
60
+
61
+ This is a [BERTIN GPT-J-6B](https://huggingface.co/bertin-project/bertin-gpt-j-6B) Spanish model fine-tuned on the [Spanish Alpaca](https://huggingface.co/datasets/bertin-project/alpaca-spanish) dataset.
62
+
63
+ ## Usage
64
+
65
+ ```python
66
+ from transformers import AutoModelForCausalLM, AutoTokenizer, GenerationConfig, pipeline
67
+
68
+ base_model = "bertin-project/bertin-gpt-j-6B-alpaca"
69
+ tokenizer = AutoTokenizer.from_pretrained(base_model)
70
+ model = AutoModelForCausalLM.from_pretrained(base_model).cuda()
71
+ ```
72
+
73
+ For generation, we can either use `pipeline()` or the model's `.generate()` method. Remember that the prompt needs a **Spanish** template:
74
+
75
+ ```python
76
+ # Generate responses
77
+ def generate(instruction, input=None):
78
+ if input:
79
+ prompt = f"""A continuación hay una instrucción que describe una tarea, junto con una entrada que proporciona más contexto. Escribe una respuesta que complete adecuadamente lo que se pide.
80
+
81
+ ### Instrucción:
82
+ {instruction}
83
+
84
+ ### Entrada:
85
+ {input}
86
+
87
+ ### Respuesta:"""
88
+ else:
89
+ prompt = f""""A continuación hay una instrucción que describe una tarea. Escribe una respuesta que complete adecuadamente lo que se pide.
90
+
91
+ ### Instrucción:
92
+ {instruction}
93
+
94
+ ### Respuesta:
95
+ """
96
+ inputs = tokenizer(prompt, return_tensors="pt")
97
+ input_ids = inputs["input_ids"].cuda()
98
+ generation_output = model.generate(
99
+ input_ids=input_ids,
100
+ generation_config=GenerationConfig(temperature=0.2, top_p=0.75, num_beams=4),
101
+ return_dict_in_generate=True,
102
+ output_scores=True,
103
+ max_new_tokens=256
104
+ )
105
+ for seq in generation_output.sequences:
106
+ output = tokenizer.decode(seq, skip_special_tokens=True)
107
+ print(output.split("### Respuesta:")[-1].strip())
108
+
109
+ generate("Escribe un correo electrónico dando la bienvenida a un nuevo empleado llamado Manolo.")
110
+ # Estimado Manolo,
111
+ #
112
+ # ¡Bienvenido a tu nuevo trabajo como Representante de Servicio al Cliente en nuestra empresa! Estamos emocionados de tenerte a bordo y esperamos que tengas un gran año trabajando con nosotros.
113
+ #
114
+ # En nombre de todos en esta empresa, queremos darte la bienvenida al equipo y desearte lo mejor en tus nuevas funciones.
115
+ #
116
+ # ¡Estamos ansiosos por escuchar tus historias y ayudarte a tener éxito en tu nuevo rol!
117
+ #
118
+ # Sinceramente,
119
+ # El equipo de Servicio al Cliente
120
+
121
+ ```
122
+
123
+
124
+ ## Data
125
+
126
+ The dataset is a translation to Spanish of [alpaca_data_cleaned.json](https://github.com/tloen/alpaca-lora/blob/main/alpaca_data_cleaned.json) (a clean version of the [Alpaca dataset made at Stanford](https://huggingface.co/datasets/tatsu-lab/alpaca)) using OpenAI's `gpt-3.5-turbo` model. We translated using a full-sample prompt instead of per strings, which resulted in more coherent tuples of `(instruction, input, output)` and costed around $60.0.
127
+
128
+ **This dataset cannot be used to create models that compete in any way with OpenAI.**
129
+
130
+ ## Finetuning
131
+
132
+ To fine-tune the BERTIN GPT-J-6B model we used the code available on [BERTIN's fork of `mesh-transformer-jax`](https://github.com/bertin-project/mesh-transformer-jax/blob/master/prepare_dataset_alpaca.py), which provides code adapt an Alpaca dataset to finetune any GPT-J-6B model. We run finetuning for 3 epochs using sequence length of 2048 on a single TPUv3-8 for 3 hours on top of BERTIN GPT-J-6B.
133
+
134
+ ## Example outputs
135
+
136
+ Stanford Alpaca:
137
+ ```
138
+ Instruction: Inventa una excusa creativa para decir que no tengo que ir a la fiesta.
139
+ Response: I'm sorry, I can't make it to the party. I have to stay home and take care of my sick pet.
140
+ ```
141
+
142
+ BERTIN Alpaca LoRA:
143
+ ```
144
+ Instruction: Inventa una excusa creativa para decir que no tengo que ir a la fiesta.
145
+ Response: No puedo ir a la fiesta porque tengo que terminar un proyecto urgente.
146
+ ```
147
+
148
+ BERTIN GPT-J-6B Alpaca:
149
+ ```
150
+ Instruction: Inventa una excusa creativa para decir que no tengo que ir a la fiesta.
151
+ Response: Lo siento, pero tengo una cita inesperada a la que necesito asistir.
152
+ ```
153
+
154
+
155
+ Stanford Alpaca:
156
+ ```
157
+ Instruction: ¿Cómo puedo comenzar una carrera como científico de datos? Responde con una lista de pasos a seguir.
158
+ Response: To begin a career as a data scientist, there are a few steps to take. First, you should have a bachelor's degree in a STEM-related field, such as computer science, mathematics, statistics, or engineering. You should also have experience with programming languages such as Python, R, or Java. Additionally, it is helpful to have knowledge of machine learning, data visualization, and data analytics. Finally, it is important to stay up to date with the latest trends and technologies in the field.
159
+ ```
160
+
161
+ BERTIN Alpaca LoRA:
162
+ ```
163
+ Instruction: ¿Cómo puedo comenzar una carrera como científico de datos? Responde con una lista de pasos a seguir.
164
+ Response: Para comenzar una carrera como científico de datos, hay varios pasos a seguir. Primero, obtener una licenciatura en matemáticas, informática o ciencias de la computación. Luego, obtener una maestría o doctorado en ciencias de la computación, informática o alguna otra área relacionada. Finalmente, obtener experiencia en el campo trabajando en proyectos de investigación o desarrollando aplicaciones.
165
+ ```
166
+
167
+ BERTIN GPT-J-6B Alpaca:
168
+ ```
169
+ Instruction: ¿Cómo puedo comenzar una carrera como científico de datos? Responde con una lista de pasos a seguir.
170
+ Response: Comenzar una carrera como científico de datos requiere una sólida formación en matemáticas, estadística e informática. También es importante tener experiencia en análisis de datos, aprendizaje automático y visualización de datos. Para prepararse para una carrera como científico de datos, considere tomar cursos en estadística, aprendizaje automático, visualización de datos y otros temas relevantes. Además, asegúrese de obtener experiencia práctica trabajando en proyectos de análisis de datos o tomando roles de aprendiz de científico de datos.
171
+ ```
172
+
173
+ You can test it using the eval notebook [here](https://colab.research.google.com/github/22-hours/cabrita/blob/main/notebooks/cabrita-lora.ipynb).
174
+
175
+ ## References
176
+
177
+ - [LLaMA](https://ai.facebook.com/blog/large-language-model-llama-meta-ai/)
178
+ - [Stanford Alpaca](https://github.com/tatsu-lab/stanford_alpaca)
179
+ - [BERTIN Alpaca](https://huggingface.co/datasets/bertin-project/alpaca-spanish)
180
+ - [ChatGPT](https://openai.com/blog/chatgpt)
181
+ - [Hugging Face](https://huggingface.co/)
182
+
183
+ ## Hardware Requirements
184
+
185
+ For training we have used a Google Cloud TPUv3-8 VM. For eval, you can use a T4.
186
+ # [Open LLM Leaderboard Evaluation Results](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
187
+ Detailed results can be found [here](https://huggingface.co/datasets/open-llm-leaderboard/details_bertin-project__bertin-gpt-j-6B-alpaca)
188
+
189
+ | Metric | Value |
190
+ |-----------------------|---------------------------|
191
+ | Avg. | 32.11 |
192
+ | ARC (25-shot) | 36.01 |
193
+ | HellaSwag (10-shot) | 54.3 |
194
+ | MMLU (5-shot) | 27.66 |
195
+ | TruthfulQA (0-shot) | 43.38 |
196
+ | Winogrande (5-shot) | 55.8 |
197
+ | GSM8K (5-shot) | 0.0 |
198
+ | DROP (3-shot) | 7.59 |
199
+
200
+