[English](README.md) | **فارسی**

# Ganjoor-Rhythm-Bench

مجموعهٔ جامعی از اشعار فارسی همراه با وزن عروضی آن‌ها. هدف اصلی، ارزیابی مدل‌های زبانی بزرگ، مدل‌های دسته‌بندی متن، یا هر مدلی است که باید بتواند وزن عروضی یک شعر فارسی را تشخیص دهد. این دادگان با استفاده از اطلاعات منتشر شده توسط [گنجور](https://ganjoor.net/) ساخته شده است. 

## پیکربندی‌ها

**`verses`**: ۲٬۲۴۰٬۹۸۵ مصرع، ۱۰۷ وزن. برای آموزش یا کارهای دیگر.

| فیلد | توضیح |
| --- | --- |
| `verse` | یک مصرع |
| `rhythm` | رشتهٔ ارکان |
| `poem_id` | شناسهٔ شعر در گنجور |
| `poet_id` | شناسهٔ شاعر در گنجور |
| `couplet_index` | شمارهٔ بیت در شعر (از صفر) |
| `mesra_index` | ترتیب مصرع در شعر (`verse_order`) |

**`benchmark`** (پیش‌فرض): ۱۲٬۷۱۳ بیت، ۴۰ وزن. مجموعهٔ اندازه‌گیری.

| فیلد | توضیح |
| --- | --- |
| `first`, `second` | دو مصرع بیت |
| `rhythm` | رشتهٔ ارکان |
| `poet`, `poet_id`, `book`, `poem_id`, `couplet_index` | فقط برای ردگیری؛ این‌ها را در پرامپت مدل نگذارید |

اگر ۱۲ هزار بیت بیشتر از نیازتان است، خودتان یک زیرمجموعهٔ ارزیابی بسازید؛ مثلاً N نمونه از هر وزن با یک seed ثابت.

```python
from datasets import load_dataset

bench = load_dataset("farbodbij/Ganjoor-Rhythm-Bench", "benchmark", split="train")
verses = load_dataset("farbodbij/Ganjoor-Rhythm-Bench", "verses", split="train")
```

## نحوهٔ ساخت

اسکریپت‌ها و تنظیمات این نسخه در [`scripts/`](scripts/) است.

1. **`extract_verses.py`**: در [دادگان گنجور](https://github.com/ganjoor/ganjoor-data) می‌گردد و مصرع‌های موزون را نگه می‌دارد.

2. **`build_benchmark.py`**:
    * حذف مصرع‌های کوتاه
    * حذف بیت اول و آخر
    * حذف تکرارها
    * حذف وزن‌های نادر
    * سقف تعداد ابیات از هر شاعر در هر وزن

3. **`probe_leakage.py`**: برای تشخیص نشت اطلاعات در این دیتاست و حذف موارد مشکوک، مصراع اول یک شعر به چند مدل زبانی داده می‌شود و از مدل خواسته می‌شود 
که مصراع دوم را برگرداند، که در صورت موقفیت مدل، آن مصراع از دیتاست حذف می‌شود. 

## استفاده در ارزیابی

کار اصلی این دادگان تشخیص وزن است. یک مصرع را بدون هیچ نشانه‌ای از شاعر، دفتر یا متادیتای مشابه به مدل بدهید و وزن عروضی شعر را بخواهید.

برای سنجش دقت تشخیص وزن می‌توان روش‌های مختلفی به کار برد:

- تابع‌های string similarity
- مقایسهٔ تک‌تک ارکان وزن (فاعلاتن در برابر فعلاتن) و دادن نمره به شباهت هر جفت رکن
- فقط تطابق کامل رشته (نمره‌دهی به صورت صفر و یک)

این انتخاب به کاربر واگذار شده است.

## سپاس و سلب مسئولیت

از تیم [گنجور](https://ganjoor.net/) بسیار سپاسگزاریم که آرشیو ارزشمندشان را به‌صورت عمومی منتشر کردند تا بتوان [دادگان فارسی](https://github.com/ganjoor) باکیفیت در اختیار جامعهٔ پردازش زبان طبیعی گذاشت. این کار هم باعث غنی‌تر شدن منابع موجود از زبان فارسی به عنوان زبانی با منابع محدود و هم باعث گسترش فرهنگ ایرانی می‌شود. 

وزن عروضی اشعار در این دادگان صرفا از داده‌های گنجور استخراج شده است و دخل و تصرفی در آن انجام نشده است. بنابرین صحت این داده‌ها وابسته به صحت داده‌های گنجور می‌باشد.