Update README.md

README.md

@@ -16,4 +16,68 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+license: apache-2.0
+task_categories:
+- text-classification
+language:
+- fa
+size_categories:
+- 1K<n<10K
 ---
+
+# Dataset Card for Persian Sentiment Comments
+
+## Dataset Description
+
+**`persian-sentiment-comments`** is a curated dataset of Persian (Farsi) user comments, each annotated with a sentiment label. The dataset is designed for **sentiment analysis tasks** and is particularly suitable for training and evaluating machine learning models on Persian text data.
+
+The comments are collected from a variety of sources, including online product reviews and user feedback. Each comment is paired with a sentiment label:
+
+- **1:** Positive sentiment  
+- **0:** Negative sentiment  
+- *(Optionally, if your dataset includes neutral comments, specify as well)*
+
+The dataset aims to support research and development in **Natural Language Processing (NLP)** for low-resource languages, especially for Persian sentiment classification.
+
+### Example
+
+| Text | Label |
+|------|-------|
+| این اولین تجربه من برای خرید ایفون هست امروز ب دستم رسیده به اسم طلایی هست ولی دراصل رزگلده خیلی هم خوش رنگ هست | 1 |
+| خرید این محصول رو توصیه میکنم | 1 |
+| یک ساله این گوشی رو دارم هیچ نقطه ضعفی ازش ندیدم | 1 |
+| سلام خدمت دوستان این گوشی از همه نظر عالی کیفیت ساخت سرعت اجرا کیفیت صدا و تصویر از نظر حافظه هم فقط 5 گیگ در دسترس شما قرار میگیره | 1 |
+| سلام دوستانی که نگران شکستن صفحه نمایش هستند این رو بدونند که صفحه با گوریلا گلس 5 محافظت میشه و با خدمات ویژه سامسونگ اگر تحت هر شرایط صفحه گوشی دچار ایراد بشه با 200 هزار تومان صفحه رو براتون تعویض میکنند و از لحاظ امکانات هم گوشی عالیه و من از خرید خودم راضیم | 1 |
+
+## Dataset Structure
+
+- **Text** (`string`): The Persian comment or review.
+- **Label** (`int64`): The sentiment label (1 = positive, 0 = negative).
+
+## Supported Tasks and Leaderboards
+
+- **Sentiment Analysis**: Classification of Persian text into positive or negative sentiment.
+- Suitable for both academic research and real-world applications in Persian NLP.
+
+## Languages
+
+- **Primary:** Persian (Farsi)
+
+## Citation
+
+If you use this dataset, please cite as:
+
+```
+@dataset{persian_sentiment_comments_2025,
+  title = {Persian Sentiment Comments Dataset},
+  author = {AICT Sharif},
+  year = {2025},
+  description = {A dataset of Persian user comments labeled for sentiment analysis.},
+  url = {https://huggingface.co/datasets/your-username/persian-sentiment-comments}
+}
+```
+
+## Contributors
+
+- [Soheil Tehranipour](https://huggingface.co/soheiltp)
+- [Masoud Kaviani](https://huggingface.co/masoudkaviani)