Codex07 commited on
Commit
6ac81aa
·
verified ·
1 Parent(s): d404541

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +79 -193
README.md CHANGED
@@ -1,200 +1,86 @@
1
  ---
2
- library_name: transformers
 
3
  tags:
 
 
 
 
 
4
  - unsloth
 
 
 
 
 
 
 
 
5
  ---
6
 
7
- # Model Card for Model ID
8
 
9
- <!-- Provide a quick summary of what the model is/does. -->
10
 
11
-
12
-
13
- ## Model Details
14
-
15
- ### Model Description
16
-
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
20
-
21
- - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
-
29
- ### Model Sources [optional]
30
-
31
- <!-- Provide the basic links for the model. -->
32
-
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
-
37
- ## Uses
38
-
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
-
41
- ### Direct Use
42
-
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
-
45
- [More Information Needed]
46
-
47
- ### Downstream Use [optional]
48
-
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
-
51
- [More Information Needed]
52
-
53
- ### Out-of-Scope Use
54
-
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
-
57
- [More Information Needed]
58
-
59
- ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- [More Information Needed]
64
-
65
- ### Recommendations
66
-
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
-
71
- ## How to Get Started with the Model
72
-
73
- Use the code below to get started with the model.
74
-
75
- [More Information Needed]
76
-
77
- ## Training Details
78
-
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- [More Information Needed]
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- [More Information Needed]
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- [More Information Needed]
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- [More Information Needed]
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- [More Information Needed]
127
-
128
- ### Results
129
-
130
- [More Information Needed]
131
-
132
- #### Summary
133
-
134
-
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- [More Information Needed]
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** [More Information Needed]
149
- - **Hours used:** [More Information Needed]
150
- - **Cloud Provider:** [More Information Needed]
151
- - **Compute Region:** [More Information Needed]
152
- - **Carbon Emitted:** [More Information Needed]
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- [More Information Needed]
159
-
160
- ### Compute Infrastructure
161
-
162
- [More Information Needed]
163
-
164
- #### Hardware
165
-
166
- [More Information Needed]
167
-
168
- #### Software
169
-
170
- [More Information Needed]
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- [More Information Needed]
179
-
180
- **APA:**
181
-
182
- [More Information Needed]
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- [More Information Needed]
189
-
190
- ## More Information [optional]
191
-
192
- [More Information Needed]
193
-
194
- ## Model Card Authors [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Contact
199
-
200
- [More Information Needed]
 
1
  ---
2
+ library_name: peft
3
+ model_name: lora_1B_TR
4
  tags:
5
+ - meta-llama/Llama-3.2-3B-Instruct
6
+ - lora
7
+ - sft
8
+ - transformers
9
+ - trl
10
  - unsloth
11
+ licence: license
12
+ pipeline_tag: text-generation
13
+ base_model: meta-llama/Llama-3.2-3B-Instruct
14
+ datasets:
15
+ - kadirnar/combined-turkish-datasets-v5
16
+ language:
17
+ - tr
18
+ - en
19
  ---
20
 
 
21
 
 
22
 
23
+ # Model Card for Lora_TR_1B
24
+
25
+ This is a Lora Adaptor of 'meta-llama/Llama-3.2-3B-Instruct'.
26
+ The main goal of this adapter is to obtain an Llama who speaks Turkish better.
27
+ >(r=32, lora_alpha=64, lora_dropout=0.005)
28
+
29
+ ## Quick start
30
+
31
+ ```python
32
+ from unsloth import FastLanguageModel
33
+ from peft import PeftModel
34
+ from transformers import AutoTokenizer
35
+
36
+ BASE = "meta-llama/Llama-3.2-3B-Instruct"
37
+ ADAPTER = "Codex07/Lora_3B_TR"
38
+
39
+ # Load Model
40
+ model, tok = FastLanguageModel.from_pretrained(
41
+ model_name=BASE, max_seq_length=2048, load_in_4bit=False, dtype=None, device_map="auto"
42
+ )
43
+ # Load Adaptor
44
+ model = PeftModel.from_pretrained(model, ADAPTER) # adapter’ı Unsloth modeline tak
45
+ FastLanguageModel.for_inference(model)
46
+
47
+ # Test
48
+ messages = [
49
+ {"role":"system","content":"You are AI assistant. Give user answers"},# Sen bir Yapay Zeka Asistanısısın. kullanıcıdan gelen sorulara resmi cevap ver.
50
+ {"role":"user","content":"Hi, can you help me?"},
51
+ {"role":"assistant","content":"I would like to help you."},
52
+ {"role":"user","content":"How many tools do you have?"},
53
+ ]
54
+ prompt = tok.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt").to(model.device)
55
+ out = model.generate(prompt, max_new_tokens=2048)
56
+ print(tok.decode(out[0, prompt.shape[-1]:], skip_special_tokens=True))
57
+ ```
58
+
59
+ ## Training procedure
60
+ Half of 'kadirnar/combined-turkish-datasets-v5' Turkish dataset used.
61
+ Dataset divided into chunks by size 65k.
62
+
63
+ This model was trained with SFT.
64
+
65
+ ### Framework versions
66
+
67
+ - PEFT 0.17.1
68
+ - TRL: 0.23.0
69
+ - Transformers: 4.56.2
70
+ - Pytorch: 2.8.0
71
+ - Datasets: 4.3.0
72
+ - Tokenizers: 0.22.1
73
+
74
+ ## Citations
75
+
76
+ Cite TRL as:
77
+ ```bibtex
78
+ @misc{vonwerra2022trl,
79
+ title = {{TRL: Transformer Reinforcement Learning}},
80
+ author = {Leandro von Werra and Younes Belkada and Lewis Tunstall and Edward Beeching and Tristan Thrush and Nathan Lambert and Shengyi Huang and Kashif Rasul and Quentin Gallou{\'e}dec},
81
+ year = 2020,
82
+ journal = {GitHub repository},
83
+ publisher = {GitHub},
84
+ howpublished = {\url{https://github.com/huggingface/trl}}
85
+ }
86
+ ```