uploaded readme

README.md

@@ -0,0 +1,163 @@
+Quantization made by Richard Erkhov.
+
+[Github](https://github.com/RichardErkhov)
+
+[Discord](https://discord.gg/pvy7H8DZMG)
+
+[Request more models](https://github.com/RichardErkhov/quant_request)
+
+
+turkish-gpt2-large-750m-instruct-v0.1 - bnb 4bits
+- Model creator: https://huggingface.co/ytu-ce-cosmos/
+- Original model: https://huggingface.co/ytu-ce-cosmos/turkish-gpt2-large-750m-instruct-v0.1/
+
+
+
+
+Original model description:
+---
+widget:
+  - text: "Türkiye'nin başkenti neresidir?"
+    example_title: "Başkent"
+  - text: "Su kıtlığı sorunlarına karşı çözümler neler olabilir?"
+    example_title: "Su Kıtlığı"
+  - text: "Yapay zeka işsizlik riski yaratıyor mu?"
+    example_title: "Yapay Zeka İşsizlik Riski"
+  - text: "Aşağıdaki makale için bir başlık önerin: Bu makale, işletmelerin müşterilerle iletişim kurma biçiminde devrim yaratmada internetin oynadığı rolü incelemektedir."
+    example_title: "Başlık Üret"
+  - text: "Aşağıdaki bağlamda orijinal bir şey söyleyin: Bir iş görüşmesini yeni bitirdiniz ve işverene bu pozisyona olan ilginizi göstermek istiyorsunuz."
+    example_title: "Role Gir"
+  - text: "Bir şirketin siber güvenliğini güçlendirmek için alınması gereken önlemler nelerdir?"
+    example_title: "Siber Güvenlik"
+  - text: "En popüler 5 programlama dili nedir?"
+    example_title: "Programlama Dilleri"
+  - text: "İnsanlık tarihinde en büyük etki yaratan birkaç icadı say."
+    example_title: "İcatlar"
+  - text: "Çok sayıda kitap okumak bir çocuğa hangi becerileri kazandırır?"
+    example_title: "Kitap Okumak"
+  - text: "Şu konuyla ilgili 5 anahtar kelimeden oluşan bir liste oluşturun: iklim değişikliği"
+    example_title: "İklim Değişikliği Anahtar Kelimeler"
+  - text: "Bilgisayarların faydaları nelerdir?"
+    example_title: "Bilgisayarların Faydaları"
+
+license: mit
+language:
+- tr
+pipeline_tag: text-generation
+base_model: ytu-ce-cosmos/turkish-gpt2-large
+
+tags:
+- Turkish
+- turkish
+- gpt2
+- instruction-tuning
+- alpaca
+---
+
+<img src="./model_cover.png" width="400px"/>
+
+# turkish-gpt2-large-750m-instruct-v0.1
+
+Derived from ytu-ce-cosmos/turkish-gpt2-large, this model is a Turkish Language Model (LLM) finetuned with a dataset consisting of 35K instructions.
+Due to the diverse nature of the training data, which includes websites, books, and other text sources, this model can exhibit biases and generate wrong answers. Users should be aware of these biases and use the model responsibly.
+
+## Quickstart
+
+```python
+import torch
+from transformers import AutoTokenizer, GPT2LMHeadModel
+from transformers import pipeline
+
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+device_id = 0 if torch.cuda.is_available() else -1
+
+model = GPT2LMHeadModel.from_pretrained("ytu-ce-cosmos/turkish-gpt2-large-750m-instruct-v0.1").to(device)
+
+tokenizer = AutoTokenizer.from_pretrained("ytu-ce-cosmos/turkish-gpt2-large-750m-instruct-v0.1")
+
+text_generator = pipeline('text-generation', model=model, tokenizer=tokenizer, device=device_id, max_new_tokens=256)
+
+def get_model_response(instruction):
+    instruction_prompt = f"### Kullanıcı:\n{instruction}\n### Asistan:\n"
+    result = text_generator(instruction_prompt)
+    generated_response = result[0]['generated_text']
+    return generated_response[len(instruction_prompt):]
+
+model_response = get_model_response("Evde egzersiz yapmanın avantajlarını açıkla.")
+print(model_response)
+"""
+Evde egzersiz yapmak, gelişmiş fiziksel ve zihinsel sağlık için harika bir yoldur. Düzenli egzersizin, artan enerji seviyeleri, gelişmiş kas gücü ve esnekliği, gelişmiş uyku kalitesi ve daha iyi genel esenlik dahil olmak üzere birçok faydası vardır. Evde egzersiz yapmak ayrıca stresi azaltmaya, kas gücünü artırmaya ve genel sağlığı iyileştirmeye yardımcı olabilir.
+"""
+```
+
+To use the chat template:
+
+```python
+chat_generator = pipeline("conversational", model=model, tokenizer=tokenizer, device=device_id, max_new_tokens=256)
+
+messages = [
+    {"role": "user", "content": "Evde egzersiz yapmanın avantajlarını açıkla."}
+]
+
+chat_outputs = chat_generator(messages)
+print(chat_outputs)
+"""
+Conversation id: 236ffc4a-2a36-4191-92fb-90d6753df1ae
+user: Evde egzersiz yapmanın avantajlarını açıkla.
+assistant: Evde egzersiz yapmak, gelişmiş fiziksel ve zihinsel sağlık için sayısız avantaj sunar. Düzenli egzersiz, stresi azaltmaya, kas gücünü artırmaya ve genel sağlığı iyileştirmeye yardımcı olabilir. Ayrıca, evde egzersiz yapmak, daha iyi uyku kalitesi, artan enerji seviyeleri ve gelişmiş bilişsel işlevler gibi daha iyi fiziksel ve zihinsel sağlık sonuçları sağlayabilir. Evde egzersiz yapmak ayrıca, gelişmiş esneklik, denge ve koordinasyon, gelişmiş kalp sağlığı ve gelişmiş kemik sağlığı dahil olmak üzere gelişmiş fiziksel ve zihinsel sağlık yararları sağlayabilir.
+"""
+```
+
+----------
+
+### Training Details
+
+- We've meticulously fine-tuned this model with a 35,000-instruction Turkish dataset to enhance its precision and adaptability.
+
+- By employing LoRA (Low-Rank Adaptation), we have successfully propelled this model to the pinnacle of its performance capabilities.
+- **LoRA** Config:
+    * rank = 256
+    * lora_alpha = 512
+    * lora_dropout = 0.05
+    * bias="none"
+    * task_type="CAUSAL_LM"
+
+- In addition to monitoring loss, we successfully integrated Rouge calculations into our system's evaluation metrics.
+- One of the innovative techniques we adopted involved employing a model to cleanse our data.
+
+Other relevant information can be found in the [paper](https://arxiv.org/abs/2404.17336).
+
+----------
+
+### Model Description
+- **Developed by:** ytu-ce-cosmos
+- **Finetuned from model :** `ytu-ce-cosmos/turkish-gpt2-large`
+
+# Acknowledgments
+- Thanks to the generous support from the Hugging Face team, it is possible to download models from their S3 storage 🤗
+- Research supported with Cloud TPUs from Google's TPU Research Cloud (TRC)
+
+----------
+
+### Citation
+```bibtex
+@article{kesgin2024introducing,
+  title={Introducing cosmosGPT: Monolingual Training for Turkish Language Models},
+  author={Kesgin, H Toprak and Yuce, M Kaan and Dogan, Eren and Uzun, M Egemen and Uz, Atahan and Seyrek, H Emre and Zeer, Ahmed and Amasyali, M Fatih},
+  journal={arXiv preprint arXiv:2404.17336},
+  year={2024}
+}
+```
+
+----------
+
+### Framework versions
+
+- PEFT 0.9.0
+
+### Contact
+COSMOS AI Research Group, Yildiz Technical University Computer Engineering Department <br>
+https://cosmos.yildiz.edu.tr/ <br>
+cosmos@yildiz.edu.tr
+
+