Update README.md

README.md

@@ -1,199 +1,179 @@
 ---
+language:
+  - tr
+  - en
+license: apache-2.0
 library_name: transformers
-tags: []
+tags:
+  - causal-lm
+  - turkish
+  - phi3
+  - llm
+  - text-generation
+  - pre-training
+  - beta
+  - syko
+pipeline_tag: text-generation
+base_model: SykoSLM/SykoLLM-V5.5-Beta
+model_type: phi3
+inference: true
+datasets:
+  - uonlp/CulturaX
+  - HuggingFaceTB/cosmopedia
+  - roneneldan/TinyStories
+  - nampdn-ai/tiny-textbooks
+  - nampdn-ai/tiny-codes
+  - ise-uiuc/Magicoder-Evol-Instruct-110K
+  - theblackcat102/evol-codealpaca-v1
+  - turkish-nlp-suite/InstrucTurca
+metrics:
+  - perplexity
 ---
 
-# Model Card for Model ID
+# 🧠 SykoLLM V5.5-Beta
 
-<!-- Provide a quick summary of what the model is/does. -->
+> ⚠️ **Bu model hâlâ beta aşamasındadır.** Üretim ortamında kullanmadan önce kapsamlı test yapmanız önerilir.
 
+**SykoLLM V5.5-Beta**, SykoLLM ailesinin şu ana kadar eğitilmiş **en büyük dil modelidir.** Phi-3 mimarisi üzerine inşa edilmiş olup Türkçe ve İngilizce metinler, kodlama veri setleri ve eğitici içerikler üzerinde ön-eğitimden (pre-training) geçirilmiştir.
 
+---
 
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- 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. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
+## 📐 Model Mimarisi
+
+| Özellik | Değer |
+|---|---|
+| **Mimari** | Phi-3 (Causal LM) |
+| **Toplam Parametre** | ~447 Milyon |
+| **Gizli Katman Boyutu** (`hidden_size`) | 1024 |
+| **Ara Katman Boyutu** (`intermediate_size`) | 3072 |
+| **Dikkat Başlığı Sayısı** (`num_attention_heads`) | 8 |
+| **Katman Sayısı** (`num_hidden_layers`) | 28 |
+| **Kelime Hazinesi** (`vocab_size`) | 32.000 |
+| **Bağlam Penceresi** (`context_length`) | 1024 token |
+| **Dikkat Mekanizması** | Flash Attention 2 |
+| **Veri Tipi** | bfloat16 |
 
-#### Summary
+---
 
+## 📚 Eğitim Veri Setleri
 
+Model aşağıdaki 8 farklı veri seti üzerinde harmanlanarak (interleave) eğitilmiştir:
 
-## Model Examination [optional]
+| Veri Seti | İçerik Türü | Dil |
+|---|---|---|
+| [uonlp/CulturaX](https://huggingface.co/datasets/uonlp/CulturaX) | Genel web metinleri (tr bölümü) | 🇹🇷 Türkçe |
+| [HuggingFaceTB/cosmopedia](https://huggingface.co/datasets/HuggingFaceTB/cosmopedia) | Sentetik eğitici içerik | 🇬🇧 İngilizce |
+| [roneneldan/TinyStories](https://huggingface.co/datasets/roneneldan/TinyStories) | Kısa, sade hikayeler | 🇬🇧 İngilizce |
+| [nampdn-ai/tiny-textbooks](https://huggingface.co/datasets/nampdn-ai/tiny-textbooks) | Ders kitabı tarzı içerik | 🇬🇧 İngilizce |
+| [nampdn-ai/tiny-codes](https://huggingface.co/datasets/nampdn-ai/tiny-codes) | Kod örnekleri ve açıklamalar | 💻 Çokdil |
+| [ise-uiuc/Magicoder-Evol-Instruct-110K](https://huggingface.co/datasets/ise-uiuc/Magicoder-Evol-Instruct-110K) | Gelişmiş kodlama talimatları | 💻 Çokdil |
+| [theblackcat102/evol-codealpaca-v1](https://huggingface.co/datasets/theblackcat102/evol-codealpaca-v1) | Kodlama talimatları | 💻 Çokdil |
+| [turkish-nlp-suite/InstrucTurca](https://huggingface.co/datasets/turkish-nlp-suite/InstrucTurca) | Türkçe instruction/yanıt çiftleri | 🇹🇷 Türkçe |
 
-<!-- Relevant interpretability work for the model goes here -->
+> Toplamda yaklaşık **~300.000 örnek** ile eğitilmiştir.
 
-[More Information Needed]
+---
 
-## Environmental Impact
+## ⚙️ Eğitim Detayları
+
+| Parametre | Değer |
+|---|---|
+| **Kullanılan Donanım** | 2× NVIDIA Tesla T4 |
+| **Eğitim Adımı** | 23.000 steps |
+| **Batch Boyutu (cihaz başına)** | 16 |
+| **Gradyan Birikimi** | 4 (efektif batch: 64) |
+| **Öğrenme Hızı** | 5e-5 |
+| **LR Zamanlayıcı** | Cosine |
+| **Isınma Adımı** | 70 |
+| **Ağırlık Bozunması** | 0.05 |
+| **Optimizatör** | AdamW (Fused) |
+| **Gradyan Kırpma** | 1.0 |
+| **Çerçeve** | HuggingFace Transformers + Trainer |
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+---
 
-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).
+## 🚀 Kullanım
 
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
 
-## Technical Specifications [optional]
+model_id = "SykoSLM/SykoLLM-V5.5-Beta"
 
-### Model Architecture and Objective
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    torch_dtype=torch.bfloat16,
+    device_map="auto"
+)
 
-[More Information Needed]
+# Sohbet formatı
+prompt = "<|user|>\nMerhaba! Nasılsın?<|end|>\n<|assistant|>\n"
 
-### Compute Infrastructure
+inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
 
-[More Information Needed]
+with torch.no_grad():
+    outputs = model.generate(
+        **inputs,
+        max_new_tokens=256,
+        do_sample=True,
+        temperature=0.7,
+        top_p=0.9,
+        repetition_penalty=1.1
+    )
 
-#### Hardware
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(response)
+```
 
-[More Information Needed]
+### Sohbet Şablonu
 
-#### Software
+Model aşağıdaki özel token formatıyla eğitilmiştir:
 
-[More Information Needed]
+```
+<|user|>
+Kullanıcı mesajı burada<|end|>
+<|assistant|>
+Modelin yanıtı burada<|end|>
+```
 
-## Citation [optional]
+---
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+## 🗺️ SykoLLM Ailesi Yol Haritası
 
-**BibTeX:**
+| Versiyon | Durum | Veri Miktarı | Donanım |
+|---|---|---|---|
+| SykoLLM V5.5-Beta | ✅ Yayında (Beta) | ~300K örnek | 2× T4 |
+| **SykoLLM V5.6** | 🔜 Geliştiriliyor | **~1.7M örnek** | **NVIDIA A100** |
 
-[More Information Needed]
+> **V5.6 ile ne değişecek?**
+> - Eğitim verisi **~5.6x büyüyecek** (300K → 1.7M örnek)
+> - A100'ün bellek ve hesaplama gücü sayesinde daha uzun bağlam ve daha derin öğrenme
+> - Türkçe dil yetkinliği önemli ölçüde artacak
+> - Beta etiketinin kaldırılması planlanmaktadır
 
-**APA:**
+---
 
-[More Information Needed]
+## ⚠️ Sınırlamalar ve Önemli Notlar
 
-## Glossary [optional]
+- Bu model **beta aşamasındadır**; tutarsız veya hatalı yanıtlar üretebilir.
+- Bağlam penceresi **1024 token** ile sınırlıdır.
+- Model yalnızca **ön-eğitim (pre-training)** görmüştür; RLHF veya DPO gibi hizalama süreçleri uygulanmamıştır.
+- Kritik, tıbbi, hukuki veya güvenlik gerektiren uygulamalarda kullanımı önerilmez.
+- Model zaman zaman Türkçe yerine İngilizce yanıt verebilir.
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+---
 
-[More Information Needed]
+## 📄 Lisans
 
-## More Information [optional]
+Bu model **Apache 2.0** lisansı altında yayınlanmıştır. Ticari kullanım serbesttir, ancak modelin kaynağının belirtilmesi beklenir.
 
-[More Information Needed]
+---
 
-## Model Card Authors [optional]
+## 🙏 Teşekkürler
 
-[More Information Needed]
+Bu modelin eğitiminde kullanılan veri setlerini açık kaynak olarak sunan tüm araştırmacılara ve topluluklara teşekkürler: HuggingFace, Turkish NLP Suite, Cosmopedia ekibi ve diğerleri.
 
-## Model Card Contact
+---
 
-[More Information Needed]
+*SykoSLM tarafından geliştirilmiştir. Sorularınız için bir Issue açabilirsiniz.*