Update README.md

README.md

@@ -14,4 +14,108 @@ tags:
 - nlp
 - sentiment
 - turkish
----
+---
+# Model Card for Model ID
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+
+## Model Details
+
+## Model Description
+
+Bu model, Türkçe metinler üzerinde **Sentiment Analysis (Duygu Analizi)** yapmak için Türkçe dilindeki giyim ürünlerine ait metinlerden oluşturulan veri kümesi kullanılarak fine-tune edilmiş bir ABSA (Aspect-Based Sentiment Analysis) modelidir. 
+Model, `yeniguno/absa-turkish-bert-dbmdz` temel modelinden türetilmiştir ve Türkçe dilindeki metinlerde olumlu, olumsuz veya nötr duygu kategorilerine ait etiketleri tahmin edebilmektedir.
+
+
+- **Developed by:** [@ebrukilic]
+- **Model type:** [Fine-Tuned ABSA Model]
+- **License:** [MIT]
+- **Finetuned from model [optional]:** [yeniguno/absa-turkish-bert-dbmdz]
+
+### Direct Use
+
+Bu model, doğrudan metin verisini alıp duygu etiketlerini tahmin etmek için kullanılabilir. Modelin çıktı olarak "olumlu", "olumsuz" veya "nötr" etiketlerinden birini döndürmesi beklenir.
+
+### Downstream Use
+
+Bu model, duygu analizi yaparak müşteri yorumlarını analiz etmek veya sosyal medya üzerindeki duygusal eğilimleri izlemek gibi downstream uygulamalarda kullanılabilir.
+
+### Out-of-Scope Use
+
+Model, sadece duygu analizi için eğitilmiştir. Karmaşık doğal dil işleme (NLP) görevleri, makale yazımı veya özetleme gibi işlemler için uygun değildir.
+
+## Bias, Risks, and Limitations
+
+Bu modelin eğitildiği veri seti, belirli bir kullanıcı grubunun yorumlarından oluşmaktadır. Bu nedenle, modelin diğer kategorilere ait metinler üzerindeki duygu analizinde sınırlı bir performans gösterebilir. 
+Ayrıca, modelin etiketleri yalnızca belirli (olumlu, olumsuz, nötr) duygu kategorilerine odaklanmaktadır ve daha karmaşık duygu durumlarını ayırt etmekte zorlanabilir.
+
+## How to Get Started with the Model
+
+Modeli, `transformers` kütüphanesini kullanarak yükleyebilir ve metinlerdeki duygu analizini gerçekleştirebilirsiniz.
+
+```python
+from transformers import AutoModelForSequenceClassification, AutoTokenizer
+
+# Model ve tokenizer yükleme
+model_name = "ebrukilic/ara-proje-bert"
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForSequenceClassification.from_pretrained(model_name)
+
+# Model ve cihaz ayarı
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+model.to(device)
+model.eval()
+
+# Test örneği
+text = "Bu film harikaydı!"
+inputs = tokenizer(text, return_tensors="pt", truncation=True, padding='max_length', max_length=128)
+inputs = {key: value.to(device) for key, value in inputs.items()}
+
+# Model tahmini
+with torch.no_grad():
+    outputs = model(**inputs)
+
+logits = outputs.logits
+predicted_class_id = torch.argmax(logits, dim=-1).item()
+
+# Etiketleri belirleme
+id_to_label = {0: "negatif", 1: "nötr", 2: "pozitif"}
+print(f"Predicted sentiment: {id_to_label[predicted_class_id]}")
+
+
+## Training Details
+
+## Eğitim Verisi
+
+Model, Türkçe metinlerdeki kullanıcı yorumları ve ilgili "aspect"ler (özellikler) kullanılarak eğitildi. Etiketler, 3 sınıflı duygu (polarite) kategorisinde `negatif`, `nötr` ve `pozitif` olarak tanımlanmıştır. Eğitim verisi 10.000'den fazla örnekten oluşmaktadır.
+
+Veri seti:
+- **Normalized Yorum**: Yorum metni
+- **Aspects**: Kullanıcı yorumu ile ilişkilendirilen konu veya özellik
+- **Polarity**: Yorumun duygusal polaritesi (negatif, nötr, pozitif)
+
+### 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
+
+Modelin performansını değerlendirmek için doğruluk (accuracy) ve F1 skoru gibi yaygın metrikler kullanılmıştır. Aşağıda modelin test verisi üzerinde elde edilen değerlendirme sonuçları yer almaktadır:
+
+Doğruluk (Accuracy): 70.72%
+F1 Skoru (Macro Average): 68.54%
+
+Model, farklı sınıflara (pozitif, nötr, negatif) eşit ağırlık vererek (macro-average) değerlendirilmiştir. Bu metrikler, modelin sınıflandırma görevindeki genel başarısını yansıtmaktadır.
+