WiroAI
/

wiroai-turkish-llm-9b

@@ -1,199 +1,235 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## 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]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- 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).
-- **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]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## 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. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: gemma
 library_name: transformers
+pipeline_tag: text-generation
+extra_gated_heading: Access Gemma on Hugging Face
+extra_gated_prompt: >-
+  To access Gemma on Hugging Face, you’re required to review and agree to
+  Google’s usage license. To do this, please ensure you’re logged in to Hugging
+  Face and click below. Requests are processed immediately.
+extra_gated_button_content: Acknowledge license
+tags:
+- conversational
+base_model:
+- google/gemma-2-9b
+language:
+- tr
+model-index:
+- name: gemma-2-9b-it-tr
+  results:
+  - task:
+      type: multiple-choice
+    dataset:
+      type: multiple-choice
+      name: MMLU_TR_V0.2
+    metrics:
+    - name: 5-shot
+      type: 5-shot
+      value: 0.5982
+      verified: false
+  - task:
+      type: multiple-choice
+    dataset:
+      type: multiple-choice
+      name: Truthful_QA_V0.2
+    metrics:
+    - name: 0-shot
+      type: 0-shot
+      value: 0.4991
+      verified: false
+  - task:
+      type: multiple-choice
+    dataset:
+      type: multiple-choice
+      name: ARC_TR_V0.2
+    metrics:
+    - name: 25-shot
+      type: 25-shot
+      value: 0.5367
+      verified: false
+  - task:
+      type: multiple-choice
+    dataset:
+      type: multiple-choice
+      name: HellaSwag_TR_V0.2
+    metrics:
+    - name: 10-shot
+      type: 10-shot
+      value: 0.5701
+      verified: false
+  - task:
+      type: multiple-choice
+    dataset:
+      type: multiple-choice
+      name: GSM8K_TR_V0.2
+    metrics:
+    - name: 5-shot
+      type: 5-shot
+      value: 0.6682
+      verified: false
+  - task:
+      type: multiple-choice
+    dataset:
+      type: multiple-choice
+      name: Winogrande_TR_V0.2
+    metrics:
+    - name: 5-shot
+      type: 5-shot
+      value: 0.6058
+      verified: false
 ---
+<img src="https://huggingface.co/WiroAI/gemma-2-9b-it-tr/blob/main/wiro_logo.png"/>
+# 🌟 Meet with WiroAI/gemma-2-9b-it-tr! A robust language model with more Turkish language and culture support! 🌟
+## 🌟 Key Features
+Fine-tuned with 500,000+ high-quality Turkish instructions
+Adapted to Turkish culture and local context
+Built on Google's cutting-edge Gemma architecture
+📝 Model Details
+Gemma-2-9b-it-tr is the Turkish-speaking member of Google's innovative Gemma model family. This model has been trained using Supervised Fine-Tuning (SFT) on carefully curated high-quality Turkish instructions. Leveraging the foundations of Gemini technology, this model demonstrates superior performance in Turkish language processing tasks.
+## 🔧 Technical Specifications
+Architecture: Decoder-only transformer
+Base Model: Google Gemma 2 9B
+Training Data: 500,000+ specially selected Turkish instructions
+Language Support: Turkish (with comprehensive local context understanding) and other common languages.
+## 💡 Use Cases
+Text Generation and Editing
+Question Answering
+Summarization
+Analysis and Reasoning
+Content Transformation
+Turkish Natural Language Processing Tasks
+Turkish Culture
+## 🚀 Advantages
+Local Understanding: Ability to comprehend Turkish culture, idioms, and current events
+Resource Efficiency: Effective operation even with limited hardware resources
+Flexible Deployment: Usable on desktop, laptop, or custom cloud infrastructure
+Open Model: Transparent and customizable architecture
+## 🌍 About Google Gemma 2
+Gemma is Google's family of lightweight, state-of-the-art open models, developed using the same research and technology used to create the Gemini models. These models are designed to be deployable in environments with limited resources, making AI technology accessible to everyone.
+## 📈 Performance and Limitations
+While the model demonstrates high performance in Turkish language tasks, users should consider the following:
+Use clear and structured instructions for best results
+Verify model outputs for critical applications
+Evaluate resource requirements before deployment
+Be aware that benchmarks below
+### Benchmark Scores
+| Models                                                    | MMLU TR | TruthfulQA TR | ARC TR | HellaSwag TR | GSM8K TR | WinoGrande TR | Average |
+|-----------------------------------------------------------|:-------:|:-------------:|:------:|:------------:|:--------:|:-------------:|:-------:|
+| WiroAI/gemma-2-9b-it-tr                                   | 59.8    | 49.9          | 53.7   | 57.0         | 66.8     | 60.6          | 58.0    |
+| selimc/OrpoGemma-2-9B-TR                                  | 53.0    | 54.3          | 52.4   | 52.0         | 64.8     | 58.9          | 55.9    |
+| Metin/Gemma-2-9b-it-TR-DPO-V1                             | 51.3    | 54.7          | 52.6   | 51.2         | 67.1     | 55.2          | 55.4    |
+| CohereForAI/aya-expanse-8b                                | 52.3    | 52.8          | 49.3   | 56.7         | 61.3     | 59.2          | 55.3    |
+| ytu-ce-cosmos/Turkish-Llama-8b-DPO-v0.1                   | 52.0    | 57.6          | 51.0   | 53.0         | 59.8     | 58.0          | 55.2    |
+| google/gemma-2-9b-it                                      | 51.8    | 53.0          | 52.2   | 51.5         | 63.0     | 56.2          | 54.6    |
+| Eurdem/Defne-llama3.1-8B                                  | 52.9    | 51.2          | 47.1   | 51.6         | 59.9     | 57.5          | 53.4    |
+| meta-llama/Meta-Llama-3-8B-Instruct                       | 52.2    | 49.2          | 44.2   | 49.2         | 56.0     | 56.7          | 51.3    |
+| WiroAI/Llama-3.1-8b-instruct-tr                           | 52.2    | 49.2          | 44.2   | 49.2         | 56.0     | 56.7          | 51.3    |
+Models Benchmarks are tested with
+```python
+lm_eval --model_args pretrained=<model_path> --tasks mmlu_tr_v0.2,arc_tr-v0.2,gsm8k_tr-v0.2,hellaswag_tr-v0.2,truthfulqa_v0.2,winogrande_tr-v0.2
+```
+Please see https://github.com/malhajar17/lm-evaluation-harness_turkish and note that we move forward with default language inference which is the same approach in OpenLLMLeaderboard v2.0
+## Usage
+### Transformers Pipeline
+```python
+import transformers
+import torch
+model_id = "WiroAI/gemma-2-9b-it-tr"
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model_id,
+    model_kwargs={"torch_dtype": torch.bfloat16},
+    device_map="auto",
+)
+pipeline.model.eval()
+instruction = "Bana İstanbul ile alakalı bir sosyal medya postu hazırlar mısın?"
+messages = [
+    {"role": "user", "content": f"{instruction}"}
+]
+prompt = pipeline.tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+terminators = [
+    pipeline.tokenizer.eos_token_id,
+    pipeline.tokenizer.convert_tokens_to_ids("<end_of_turn>")
+]
+outputs = pipeline(
+    prompt,
+    max_new_tokens=512,
+    eos_token_id=terminators,
+    do_sample=True,
+    temperature=0.9,
+)
+print(outputs[0]["generated_text"][len(prompt):])
+```
+```markdown
+İstanbul'un büyüsüne kapılın! :city_sunset:
+Halk arasında "dünyanın masalı şehri" olarak bilinen İstanbul, her köşesinde tarih, kültür ve modern yaşamın bir araya geldiği eşsiz bir şehir.
+Yüzyıllardır farklı medeniyetlerin izlerini taşıyan İstanbul, tarihi mekanlarından, müzelerinden, çarşılarından ve restoranlarından oluşan zengin kültürel mirasa sahiptir.
+Boğaz'ın eşsiz manzarasında tekne turu yapmak, Topkapı Sarayı'nı ziyaret etmek, Grand Bazaar'da alışveriş yapmak, Mısır Çarşısı'nın canlı atmosferinde kaybolmak, Galata Kulesi'nden muhteşem bir manzara deneyimlemek veya Beyoğlu'nun hareketli sokaklarında yürüyüş yapmak İstanbul'da unutulmaz anılar yaratmak için fırsatlar sunar.
+İstanbul'un büyülü atmosferini kendiniz yaşamak için hemen planınızı yapın! :flag-tr: #İstanbul #Türkiye #Seyahat #Tarih #Kültür #Gezi
+```
+## 🤝 License and Usage
+This model is provided under Google's Gemma license. Please review and accept the license terms before use.
+## 📫 Contact and Support
+For questions, suggestions, and feedback, please open an issue on HuggingFace or contact us directly from our website.
+## Citation
+```none
+@article{WiroAI,
+  title={gemma-2-9b-it-tr},
+  author={Abdullah Bezir, Furkan Burhan Türkay, Cengiz Asmazoğlu},
+  year={2024},
+  url={https://huggingface.co/WiroAI/gemma-2-9b-it-tr}
+}
+```
+```none
+@article{gemma_2024,
+    title={Gemma},
+    url={https://www.kaggle.com/m/3301},
+    DOI={10.34740/KAGGLE/M/3301},
+    publisher={Kaggle},
+    author={Gemma Team},
+    year={2024}
+}
+```