burak commited on
Commit
ee794d6
·
verified ·
1 Parent(s): 8e34a6a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -202
README.md CHANGED
@@ -1,202 +1,68 @@
1
- ---
2
- library_name: transformers
3
- license: apache-2.0
4
- language:
5
- - tr
6
- - en
7
- ---
8
-
9
- # Model Card for Model ID
10
-
11
- <!-- Provide a quick summary of what the model is/does. -->
12
-
13
-
14
-
15
- ## Model Details
16
-
17
- ### Model Description
18
-
19
- <!-- Provide a longer summary of what this model is. -->
20
-
21
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
22
-
23
- - **Developed by:** [More Information Needed]
24
- - **Funded by [optional]:** [More Information Needed]
25
- - **Shared by [optional]:** [More Information Needed]
26
- - **Model type:** [More Information Needed]
27
- - **Language(s) (NLP):** [More Information Needed]
28
- - **License:** [More Information Needed]
29
- - **Finetuned from model [optional]:** [More Information Needed]
30
-
31
- ### Model Sources [optional]
32
-
33
- <!-- Provide the basic links for the model. -->
34
-
35
- - **Repository:** [More Information Needed]
36
- - **Paper [optional]:** [More Information Needed]
37
- - **Demo [optional]:** [More Information Needed]
38
-
39
- ## Uses
40
-
41
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
-
43
- ### Direct Use
44
-
45
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
-
47
- [More Information Needed]
48
-
49
- ### Downstream Use [optional]
50
-
51
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
-
53
- [More Information Needed]
54
-
55
- ### Out-of-Scope Use
56
-
57
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
-
59
- [More Information Needed]
60
-
61
- ## Bias, Risks, and Limitations
62
-
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
-
65
- [More Information Needed]
66
-
67
- ### Recommendations
68
-
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
-
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
-
73
- ## How to Get Started with the Model
74
-
75
- Use the code below to get started with the model.
76
-
77
- [More Information Needed]
78
-
79
- ## Training Details
80
-
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- [More Information Needed]
86
-
87
- ### Training Procedure
88
-
89
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
-
91
- #### Preprocessing [optional]
92
-
93
- [More Information Needed]
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
-
122
- [More Information Needed]
123
-
124
- #### Metrics
125
-
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
-
128
- [More Information Needed]
129
-
130
- ### Results
131
-
132
- [More Information Needed]
133
-
134
- #### Summary
135
-
136
-
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- [More Information Needed]
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** [More Information Needed]
151
- - **Hours used:** [More Information Needed]
152
- - **Cloud Provider:** [More Information Needed]
153
- - **Compute Region:** [More Information Needed]
154
- - **Carbon Emitted:** [More Information Needed]
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- [More Information Needed]
161
-
162
- ### Compute Infrastructure
163
-
164
- [More Information Needed]
165
-
166
- #### Hardware
167
-
168
- [More Information Needed]
169
-
170
- #### Software
171
-
172
- [More Information Needed]
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- [More Information Needed]
181
-
182
- **APA:**
183
-
184
- [More Information Needed]
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- [More Information Needed]
191
-
192
- ## More Information [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Authors [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Contact
201
-
202
- [More Information Needed]
 
1
+ # Burak Phi-3 Mini (233M) - Experimental
2
+
3
+ > **⚠️ Uyarı:** Bu model şu anda aktif bir **test aşamasındadır**. Amacı, yeni nesil **Phi-3** mimarisinin yeteneklerini sıfırdan eğitilmiş bir yapıyla (from scratch) küçük ölçekte test etmektir. Üretime (production) hazır bir model değildir ve halüsinasyon görebilir veya beklenmedik yanıtlar verebilir.
4
+
5
+ ## Model Özeti
6
+ Bu model, Microsoft'un **Phi-3** mimarisi temel alınarak sıfırdan eğitilmiş **233 Milyon** parametreli, deneysel bir dil modelidir. Hem İngilizce hem de Türkçe dillerinde genel bilgi, kodlama yeteneği ve mantıksal yürütme (reasoning) kapasitesini ölçmek amacıyla çeşitli yüksek kaliteli veri setleri harmanlanarak eğitilmiştir.
7
+
8
+ Ayrıca model için `BPE` (Byte-Pair Encoding) tabanlı **özel bir tokenizer** sıfırdan eğitilmiş ve kullanılmıştır.
9
+
10
+ ## Model Mimarisi Detayları
11
+ Model, standart LLaMA/Phi yapılandırmalarına benzer ancak daha kompakt bir konfigürasyonda tasarlanmıştır:
12
+ * **Mimari:** Phi-3 (`Phi3ForCausalLM`)
13
+ * **Parametre Sayısı:** 233M
14
+ * **Gömme Boyutu (Hidden Size):** 768
15
+ * **Ara Katman Boyutu (Intermediate Size):** 2304
16
+ * **Katman Sayısı (Hidden Layers):** 24
17
+ * **Dikkat Başlıkları (Attention Heads):** 6 (GQA destekli)
18
+ * **Bağlam Penceresi (Context Size):** 1024 Token
19
+ * **Sözlük Boyutu (Vocab Size):** 32,000
20
+
21
+ ## Eğitim Verisi (Datasets)
22
+ Eğitim verisi, modelin çok yönlü olabilmesi için özenle seçilmiş, yapay zeka kalıntıları (AI-robots) temizlenmiş ve filtrelenmiş şu veri setlerinden oluşmaktadır:
23
+
24
+ **Genel Bilgi ve Mantık (İngilizce & Hikaye):**
25
+ * `HuggingFaceTB/cosmopedia` (Math, KhanAcademy, OpenStax, Stanford, Web Samples, WikiHow)
26
+ * `roneneldan/TinyStories`
27
+ * `nampdn-ai/tiny-textbooks`
28
+
29
+ **Kodlama ve Talimat (Coding & Instruct):**
30
+ * `nampdn-ai/tiny-codes`
31
+ * `ise-uiuc/Magicoder-Evol-Instruct-110K`
32
+ * `theblackcat102/evol-codealpaca-v1`
33
+
34
+ **Türkçe Veriler:**
35
+ * `uonlp/CulturaX` (Türkçe alt kümesi, temizlenmiş)
36
+ * `turkish-nlp-suite/InstrucTurca`
37
+
38
+ ## Eğitim Konfigürasyonu
39
+ * **Optimizasyon:** 8-bit AdamW (`adamw_bnb_8bit`)
40
+ * **Öğrenme Oranı (Learning Rate):** 3e-4 (Cosine Scheduler ile)
41
+ * **Hassasiyet (Precision):** FP16
42
+ * **Max Adım Sayısı:** 6000
43
+
44
+ ## Örnek Kullanım (Inference)
45
+ Modeli denemek için aşağıdaki Python kodunu kullanabilirsiniz:
46
+
47
+ ```python
48
+ from transformers import AutoModelForCausalLM, AutoTokenizer
49
+ import torch
50
+
51
+ model_id = "kullanici_adin/burak-phi3-233m" # Burayı kendi reponla değiştir
52
+
53
+ # Modeli ve Tokenizer'ı yükle
54
+ tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
55
+ model = AutoModelForCausalLM.from_pretrained(model_id, trust_remote_code=True, device_map="auto")
56
+
57
+ prompt = "<|user|>\nPython ile bir 'Hello World' yaz.\n<|end|>\n<|assistant|>\n"
58
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
59
+
60
+ outputs = model.generate(
61
+ **inputs,
62
+ max_new_tokens=100,
63
+ temperature=0.7,
64
+ do_sample=True,
65
+ eos_token_id=tokenizer.eos_token_id
66
+ )
67
+
68
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))