rhaymison commited on
Commit
1b0b701
1 Parent(s): b7be3db

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +90 -171
README.md CHANGED
@@ -1,199 +1,118 @@
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
+ - portugues
8
+ - portuguese
9
+ - QA
10
+ - instruct
11
+ - phi
12
+ base_model: microsoft/Phi-3-mini-4k-instruct
13
+ datasets:
14
+ - rhaymison/superset
15
+ pipeline_tag: text-generation
16
  ---
17
 
18
+ # Llama3-portuguese-luana-8b-instruct
19
 
20
+ <p align="center">
21
+ <img src="https://raw.githubusercontent.com/rhaymisonbetini/huggphotos/main/tom-cat.webp" width="50%" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
22
+ </p>
23
 
24
 
25
+ This model was trained with a superset of 300,000 chat in Portuguese.
26
+ The model comes to help fill the gap in models in Portuguese. Tuned from the microsoft/Phi-3-mini-4k.
27
 
28
+ # How to use
29
 
30
+ ### FULL MODEL : A100
31
+ ### HALF MODEL: L4
32
+ ### 8bit or 4bit : T4 or V100
33
 
34
+ You can use the model in its normal form up to 4-bit quantization. Below we will use both approaches.
35
+ Remember that verbs are important in your prompt. Tell your model how to act or behave so that you can guide them along the path of their response.
36
+ Important points like these help models (even smaller models like 8b) to perform much better.
37
 
38
+ ```python
39
+ !pip install -q -U transformers
40
+ !pip install -q -U accelerate
41
+ !pip install -q -U bitsandbytes
42
 
43
+ from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
44
+ model = AutoModelForCausalLM.from_pretrained("rhaymison/phi-3-portuguese-tom-cat-4k-instructt", device_map= {"": 0})
45
+ tokenizer = AutoTokenizer.from_pretrained("rhaymison/phi-3-portuguese-tom-cat-4k-instruct")
46
+ model.eval()
 
 
 
47
 
48
+ ```
49
 
50
+ You can use with Pipeline.
51
+ ```python
52
 
53
+ from transformers import pipeline
54
+ pipe = pipeline("text-generation",
55
+ model=model,
56
+ tokenizer=tokenizer,
57
+ do_sample=True,
58
+ max_new_tokens=512,
59
+ num_beams=2,
60
+ temperature=0.3,
61
+ top_k=50,
62
+ top_p=0.95,
63
+ early_stopping=True,
64
+ pad_token_id=tokenizer.eos_token_id,
65
+ )
66
 
 
67
 
68
+ def format_template(question:str):
69
+ 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."
70
+ return f"""<s><|system|>
71
+ { system_prompt }
72
+ <|user|>
73
+ { question }
74
+ <|assistant|>
75
+ """
76
 
77
+ question = format_template("E possivel ir de Carro dos Estados unidos ate o japão")
78
+ pipe(question)
79
+ ```
80
 
81
+ If you are having a memory problem such as "CUDA Out of memory", you should use 4-bit or 8-bit quantization.
82
+ For the complete model in colab you will need the A100.
83
+ If you want to use 4bits or 8bits, T4 or L4 will already solve the problem.
84
 
85
+ # 4bits example
86
 
87
+ ```python
88
+ from transformers import BitsAndBytesConfig
89
+ import torch
90
+ nb_4bit_config = BitsAndBytesConfig(
91
+ load_in_4bit=True,
92
+ bnb_4bit_quant_type="nf4",
93
+ bnb_4bit_compute_dtype=torch.bfloat16,
94
+ bnb_4bit_use_double_quant=True
95
+ )
96
 
97
+ model = AutoModelForCausalLM.from_pretrained(
98
+ base_model,
99
+ quantization_config=bnb_config,
100
+ device_map={"": 0}
101
+ )
102
 
103
+ ```
104
 
 
105
 
106
+ ### Comments
107
 
108
+ Any idea, help or report will always be welcome.
109
 
110
111
 
112
+ <div style="display:flex; flex-direction:row; justify-content:left">
113
+ <a href="https://www.linkedin.com/in/heleno-betini-2b3016175/" target="_blank">
114
+ <img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white">
115
+ </a>
116
+ <a href="https://github.com/rhaymisonbetini" target="_blank">
117
+ <img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">
118
+ </a>