rhaymison commited on
Commit
4764103
1 Parent(s): 1f69948

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +93 -168
README.md CHANGED
@@ -1,199 +1,124 @@
1
  ---
 
 
 
2
  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]
 
1
  ---
2
+ language:
3
+ - pt
4
+ license: apache-2.0
5
  library_name: transformers
6
+ tags:
7
+ - portuguese
8
+ - brasil
9
+ - gemma
10
+ - portugues
11
+ - instrucao
12
+ datasets:
13
+ - rhaymison/superset
14
+ base_model: google/gemma-2b-it
15
+ pipeline_tag: text-generation
16
  ---
17
 
18
+ # gemma-portuguese-2b-luana
19
 
 
20
 
21
+ <p align="center">
22
+ <img src="https://raw.githubusercontent.com/rhaymisonbetini/huggphotos/main/tom-cat-2b.webp" width="50%" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
23
+ </p>
24
 
25
 
 
26
 
27
+ ## Model description
28
 
29
+ updated: 2024-04-10 20:06
30
 
31
+ The gemma-portuguese-2b model is a portuguese model trained with the superset dataset with 250,000 instructions.
32
+ The model is mainly focused on text generation and instruction.
33
+ The model was not trained on math and code tasks.
34
+ The model is generalist with focus on understand portuguese inferences.
35
+ With this fine tuning for portuguese, you can adjust the model for a specific field.
36
 
37
+ ## How to Use
 
 
 
 
 
 
38
 
 
39
 
40
+ ```python
41
+ from transformers import AutoTokenizer, pipeline
42
+ import torch
43
 
44
+ model = "rhaymison/gemma-portuguese-luana-2b"
 
 
45
 
46
+ tokenizer = AutoTokenizer.from_pretrained(model)
47
+ pipeline = pipeline(
48
+ "text-generation",
49
+ model=model,
50
+ model_kwargs={"torch_dtype": torch.bfloat16},
51
+ device="cuda",
52
+ )
53
 
54
+ messages = [
55
+ {
56
+ "role": "system",
57
+ "content": "Abaixo está uma instrução que descreve uma tarefa, juntamente com uma entrada que fornece mais contexto. Escreva uma resposta que complete adequadamente o pedido."
58
+ },
59
+ {"role": "user", "content": "Me conte sobre a ida do homem a Lua."},
60
+ ]
61
+ prompt = pipeline.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
62
+ outputs = pipeline(
63
+ prompt,
64
+ max_new_tokens=256,
65
+ do_sample=True,
66
+ temperature=0.2,
67
+ top_k=50,
68
+ top_p=0.95
69
+ )
70
+ print(outputs[0]["generated_text"][len(prompt):].replace("model",""))
71
 
72
+ #A viagem à Lua foi um esforço monumental realizado pela Agência Espacial dos EUA entre 1969 e 1972.
73
+ #Foi um marco significativo na exploração espacial e na ciência humana.
74
+ #Aqui está uma visão geral de sua jornada: 1. O primeiro voo espacial humano foi o de Yuri Gagarin, que voou a Terra em 12 de abril de 1961.
75
+ ```
76
 
 
77
 
78
+ ```python
79
+ from transformers import AutoTokenizer, AutoModelForCausalLM
80
 
81
+ tokenizer2 = AutoTokenizer.from_pretrained("rhaymison/gemma-portuguese-tom-cat-2b-it")
82
+ model2 = AutoModelForCausalLM.from_pretrained("rhaymison/gemma-portuguese-tom-cat-2b-it", device_map={"":0})
83
+ tokenizer2.pad_token = tokenizer2.eos_token
84
+ tokenizer2.add_eos_token = True
85
+ tokenizer2.add_bos_token, tokenizer2.add_eos_token
86
+ tokenizer2.padding_side = "right"
87
+ ```
88
 
89
+ ```python
90
+ def format_template( question:str):
91
+ system_prompt = "Abaixo está uma instrução que descreve uma tarefa, juntamente com uma entrada que fornece mais contexto. Escreva uma resposta que complete adequadamente o pedido."
92
+ text = f"""<bos>system
93
+ {system_prompt}<end_of_turn>
94
+ <start_of_turn>user
95
+ ###instrução: {question} <end_of_turn>
96
+ <start_of_turn>model"""
97
+ return text
98
 
99
+ question = format_template("Me conte sobre a ida do homem a Lua")
100
 
101
+ device = "cuda:0"
102
 
103
+ inputs = tokenizer2(text, return_tensors="pt").to(device)
104
 
105
+ outputs = model2.generate(**inputs, max_new_tokens=256, do_sample=False)
106
 
107
+ output = tokenizer2.decode(outputs[0], skip_special_tokens=True, skip_prompt=True)
108
+ print(output.replace("model"," "))
109
+ ```
110
 
111
+ ### Comments
112
 
113
+ Any idea, help or report will always be welcome.
114
 
115
116
 
117
+ <div style="display:flex; flex-direction:row; justify-content:left">
118
+ <a href="https://www.linkedin.com/in/heleno-betini-2b3016175/" target="_blank">
119
+ <img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white">
120
+ </a>
121
+ <a href="https://github.com/rhaymisonbetini" target="_blank">
122
+ <img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">
123
+ </a>
124
+ </div>