Update README.md

README.md

@@ -15,6 +15,53 @@ datasets:
 - musabg/wikipedia-tr-summarization
 pipeline_tag: text-generation
 ---
+## Introduction
+Model was tested 1500 wikipedia articles, and was measured by these metrics:
+- Model's average Rouge-1 score: 0.500
+- Model's averageRouge-l score: 0.413
+- Model's average Bertscore: 0.714
+- **GGUF version**: https://huggingface.co/anilguven/Llama3.2-3b-TrSummarization-unsloth-GGUF
+
+## Usage 🚀
+
+```python
+from unsloth import FastLanguageModel
+max_seq_length = 1024 # Choose any! We auto support RoPE Scaling internally!
+dtype = None # None for auto detection. Float16 for Tesla T4, V100, Bfloat16 for Ampere+
+load_in_4bit = True # Use 4bit quantization to reduce memory usage. Can be False.
+
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name = "anilguven/Llama3.2-3b-TrSummarization-unsloth", # YOUR MODEL YOU USED FOR TRAINING
+    max_seq_length = max_seq_length,
+    dtype = dtype,
+    load_in_4bit = load_in_4bit,
+)
+FastLanguageModel.for_inference(model) # Enable native 2x faster inference
+```
+
+### Example
+```python
+prompt = """Aşağıda, bir girdinin özet hali çıktıda verilmiştir. Girdiyi uygun şekilde özetleyin.
+### Input (Girdi):
+{}
+### Response (Yanıt):
+{}"""
+
+inputs = tokenizer(
+[
+    prompt.format(
+        """IBOR Interbank Offered Rate (Bankalararası Teklif edilen Faiz oranı) başharfleridır. Belirtilmiş bir zamanda, ilk kategoriden bir Bankanın ayni kategoriden başka bir bankaya, hiçbir karşılık garanti verilmeden (İngilizcesı : unsecured lending), ödünç verilmesı için kullanılan faiz oranıdır. Ödünç karşılığında hiçbir varlık ya da güvenlik verilmediği için riskli bir işlemdır.Bankalararası Karşılıksız Ödünç 
+Bankalararası Karşılıksız Ödünç Para Merkezlerinin en pahalı, en riskli ama aynı şekilde en çok kontrol altında olan işlemidir. Bundan dolayı, nadir, ve toplam miktarda ağır olmayan bir işlemdır. Bunun üzerinde, kısa süreler için kullanılır. İki yıllık Bilanço arasında, yani 31 Aralığı geçtıkten sonra, pek kullanılmaz.Bunlara rağmen, türev finansal ürünler merkezinin büyük bir bölümü bu küçük merkeze bağlıdır.""", # input
+        "", # output - leave this blank for generation!
+    )
+], return_tensors = "pt").to("cuda")
+
+from transformers import TextStreamer
+text_streamer = TextStreamer(tokenizer, skip_prompt = True)
+output = model.generate(input_ids = inputs.input_ids, attention_mask = inputs.attention_mask,
+                   streamer = text_streamer, max_new_tokens = 256, pad_token_id = tokenizer.eos_token_id)
+```
+> IBOR, bankalararası karşılıksız ödünç para merkezlerinin en pahalı, en riskli ama aynı zamanda en çok kontrol altında olan işlemidir ve nadir, toplam miktarda ağır olmayan işlemlerden biridir.
 
 # Uploaded  model