Update README.md

README.md

@@ -1,3 +1,47 @@
 ---
 license: openrail
+language:
+- tr
+pipeline_tag: text-generation
+library_name: transformers
+tags:
+- alpaca
+- llama
+- LLM
+- Turkish
+datasets:
+- tatsu-lab/alpaca
+inference: false
 ---
+
+Sokullu-LoRA-13b is a LLaMA-13B model fine-tuned on the translated [Stanford Alpaca](https://github.com/tatsu-lab/stanford_alpaca) dataset to follow the 🇹🇷 Turkish instructions.
+
+For more information, please visit the Github repo: https://github.com/esokullu/sokullu-lora
+
+**Usage and License Notices**: Same as [Stanford Alpaca](https://github.com/tatsu-lab/stanford_alpaca), Sokullu-LoRA is intended and licensed for research use only. The dataset is CC BY NC 4.0 (allowing only non-commercial use) and models trained using the dataset should not be used outside of research purposes.
+
+## Usage
+This repo only contains the low-rank adapter. In order to access the complete model, you also need to load the base LLM model and tokenizer.
+
+```python
+from peft import PeftModel
+from transformers import LlamaForCausalLM, LlamaTokenizer
+
+base_model_name_or_path = "<name/or/path/to/hf/llama/13b/model>"
+lora_model_name_or_path = "sokullu/sokullu-lora-13b"
+
+tokenizer = LlamaTokenizer.from_pretrained(base_model_name_or_path)
+model = LlamaForCausalLM.from_pretrained(
+    base_model_name_or_path,
+    load_in_8bit=True,
+    device_map="auto",
+)
+model = PeftModel.from_pretrained(model, lora_model_name_or_path)
+```
+You can infer this model by using the following Google Colab Notebook.
+
+## Limitations
+Sokullu-LoRA is still under development, and there are many limitations that have to be addressed. Please note that it is possible that the model generates harmful or biased content, incorrect information or generally unhelpful answers.
+
+
+