Update README.md

README.md

@@ -2,14 +2,73 @@
 license: apache-2.0
 datasets:
 - oscar
+- mc4
 language:
 - tr
 pipeline_tag: text-generation
 widget:
-- text: "Benim adım Ali"
-  example_title: "Ali"
-- text: "Benim adım Merve, ve en sevdiğim"
-  example_title: "Merve"
+- text: "Benim adım Zeynep, ve en sevdiğim kitap"
+  example_title: "Benim adım Zeynep"
 - text: "Bugünkü yemeğimiz"
-  example_title: "Yemek"
+  example_title: "Bugünkü yemeğimiz"
 ---
+
+# Kanarya-2B: Turkish Language Model
+
+<img src="https://asafaya.me/images/kanarya.webp" alt="Kanarya Logo" style="width:300px;"/>
+
+Kanarya is a pre-trained Turkish GPT-J 2B model. Released as part of [Turkish Data Depository](https://tdd.ai/) efforts, the Kanarya family has two versions (Kanarya-2B, Kanarya-0.7B). Kanarya-2B is the larger version and Kanarya-0.7B is the smaller version. Both models are trained on a large-scale Turkish text corpus, filtered from OSCAR and mC4 datasets. The training data is collected from various sources, including news, articles, and websites, to create a diverse and high-quality dataset. The models are trained using a JAX/Flax implementation of the [GPT-J](https://github.com/kingoflolz/mesh-transformer-jax) architecture.
+
+## Model Details
+
+- Model Name: Kanarya-2B
+- Model Size: 2,050M parameters
+- Training Data: OSCAR, mC4
+- Language: Turkish
+- Layers: 24
+- Hidden Size: 2560
+- Number of Heads: 20
+- Context Size: 2048
+- Positional Embeddings: Rotary
+- Vocabulary Size: 32,768
+
+## Intended Use
+
+This model is only pre-trained on Turkish text data and is intended to be fine-tuned on a wide range of Turkish NLP tasks. The model can be used for various Turkish NLP tasks, including text generation, translation, summarization, and other Turkish NLP tasks. This model is not intended to be used for any downstream tasks without fine-tuning.
+
+## Limitations and Ethical Considerations
+
+The model is trained on a diverse and high-quality Turkish text corpus, but it may still generate toxic, biased, or unethical content. It is highly recommended to use the model responsibly and make sure that the generated content is appropriate for the use case. Please use the model responsibly and report any issues.
+
+## License: Apache 2.0
+
+The model is licensed under the Apache 2.0 License. It is free to use for any purpose, including commercial use. We encourage users to contribute to the model and report any issues. However, the model is provided "as is" without warranty of any kind.
+
+## Citation
+
+If you use the model, please cite the following paper:
+
+```bibtex
+@inproceedings{safaya-etal-2022-mukayese,
+    title = "Mukayese: {T}urkish {NLP} Strikes Back",
+    author = "Safaya, Ali  and
+      Kurtulu{\c{s}}, Emirhan  and
+      Goktogan, Arda  and
+      Yuret, Deniz",
+    editor = "Muresan, Smaranda  and
+      Nakov, Preslav  and
+      Villavicencio, Aline",
+    booktitle = "Findings of the Association for Computational Linguistics: ACL 2022",
+    month = may,
+    year = "2022",
+    address = "Dublin, Ireland",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2022.findings-acl.69",
+    doi = "10.18653/v1/2022.findings-acl.69",
+    pages = "846--863",
+}
+```
+
+## Acknowledgments
+
+During this work, Ali Safaya was supported by [KUIS AI Center](https://ai.ku.edu.tr/) fellowship. Moreover, the pre-training of these models were performed at TUBITAK ULAKBIM, High Performance and Grid Computing Center ([TRUBA](https://www.truba.gov.tr/index.php/en/main-page/) resources).