added examples

README.md

@@ -1,8 +1,8 @@
 ---
 title: AraPoet
-emoji: ⚡
-colorFrom: red
-colorTo: pink
+emoji: ✍️
+colorFrom: green
+colorTo: blue
 sdk: gradio
 sdk_version: 3.18.0
 app_file: app.py

app.py

@@ -39,7 +39,7 @@ def generate_poem(country, era, meter, theme, lang_type, poet, num_lines, num_po
         prompt += f"{name}: {feat}; "
     prompt += f"Length: {num_lines}; Poem:"
 
-    num_beams = 2
+    num_beams = 3
     top_k = 50
     top_p = 0.9
     r_penalty = 5.
@@ -80,9 +80,21 @@ tokenizer: AutoTokenizer = AutoTokenizer.from_pretrained("bkhmsi/arapoet-mt5", u
 model: AutoModelForSeq2SeqLM = AutoModelForSeq2SeqLM.from_pretrained("bkhmsi/arapoet-mt5", use_auth_token="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")
 model.eval()
 
-title = "AraPoet: Controlled Arabic Poetry Generation"
+title = ""
 with gr.Blocks(title=title) as demo:
     inputs = []
+
+    gr.Markdown(
+        """
+        # AraPoet: Controlled Arabic Poetry Generation
+        
+        The model hosted here is a finetuned version of [mT5-large](https://huggingface.co/google/mt5-large) (∼ 1.2B parameters) on the largest repository of Arabic poems, the [ashaar](https://huggingface.co/datasets/arbml/ashaar) dataset. 
+        The model can be conditioned on a set of attributes to control the style of the generated poem. 
+        Namely: the poet name, country, era, meter, theme, language type, title and the length of the poem.
+        You can start by clicking on one of the examples below or try your own input.
+        """
+    )
+
     with gr.Row():
         inputs += [gr.Dropdown(countries, label="Country", value="None")]
         inputs += [gr.Dropdown(poet_era, label="Era", value="None")]
@@ -99,6 +111,14 @@ with gr.Blocks(title=title) as demo:
         inputs += [gr.Textbox(label="Title")]
 
     btn = gr.Button("Generate")
+    examples = gr.Examples(examples="./examples", inputs=inputs)
     btn.click(generate_poem, inputs, gr.TextArea(label="Generation"))
 
+
+    gr.Markdown(
+        """
+        Checkout our [AraPoet Preprint](https://github.com/BKHMSI/BKHMSI.github.io/blob/master/archive/resources/AraPoet.pdf) for more details about the model.
+        """
+    )
+
 demo.launch()

examples/log.csv

@@ -0,0 +1,30 @@
+country,era,meter,theme,lang_type,poet,num_lines,num_poems,titleNone,None,None,None,فصحى,خالد مصباح مظلوم,10,1,النساء ضحايا أحوالنا
+None,None,None,None,فصحى,ابن الرومي,10,1,نجَّاكَ يا ابن الحاجِبِ الحاجبُ
+العراق,العصر الحديث,المتقارب,None,فصيح,أحمد الصافي النجفي ,10,1,None
+None,None,None,None,فصيح,أبو العلاء المعري,10,1,البارق المتعالي
+None,None,None,None,فصحى,البحتري,10,1,أخا علة سار الإخاء فأوضعا
+None,العصر المملوكي,بحر موشح,قصيدة الاناشيد,None,ابن نباته المصري,10,1,حشى من نار صدك ذائبة
+None,None,None,None,فصيح,ريم سليمان الخش,10,1,مصيرها حلّاجي....
+None,None,None,None,فصيح,السيد عبد الله سالم,10,1,زمليني
+None,None,None,None,None,حسن حسني الطويراني,10,1,ابدأ بنفسك فاظهر كنه خافيها
+None,None,None,None,فصيح,المفتي فتح الله,10,1,مُنِحتَ بَشيرَ الخيرِ بِالخَيرِ والجَدِّ
+None,None,None,None,فصحى,جبران خليل جبران,10,1,لا تغاري من حسنها الملحود
+None,None,None,None,فصيح,محمود المشهداني,10,1,والعوْدُ أحمد
+None,None,None,None,فصيح,ابن الوردي,10,1,قالَ لها الشيخُ واصليني
+None,None,None,None,فصحى,خليل مطران,10,1,طَويْنَا الحُقُولَ سِرَاعَ الْمَسِيرِ
+None,العصر العباسي,بحر البسيط,قصيدة قصيره,None,ابو نواس,10,1,لا تحفلن بقول الزاجر اللاحي
+None,None,None,None,فصحى,أحمد شوقي,10,1,بِأَبي  وَروحي   الناعِماتِ   الغيدا
+None,None,None,None,فصحى,نزار قباني,10,1,رسالة حُبّ (61) - (70)
+None,None,None,None,فصحى,الفرزدق,10,1,ألم يأت بالشأم الخليفة أننا
+None,None,بحر الكامل,None,None,لسان الدين بن الخطيب,10,1, الْحَقُّ يَعْلُو وَالأَبَاطِلُ تَسْفُلُ
+None,None,None,None,فصحى,عبد الغني النابلسي,10,1,كواكب جرت من السماء
+None,None,بحر المتقارب,None,None,الشريف العقيلي,10,1, وَسِترٍ لَهُ مَنظَرٌ مونِقٌ
+None,None,None,None,None,ماء العينين,10,1,قال عبيد الله ما العينين
+None,None,بحر الخفيف,None,None,جميل صدقي الزهاوي,10,1, كل ما تبتغيه منا الحياة
+None,None,None,None,فصحى,بشار بن برد,10,1,منَّيْتَنِي بِشْراً وبشرٌ فتًى
+None,None,None,None,فصحى,صفي الدين الحلي,10,1,لئن ثلمتْ حدّي صُروفُ النّوائبِ
+None,None,بحر الطويل,None,None,محيي الدين بن عربي,10,1, أمرت فلم أسمع دعوتُ فلم تجب
+None,None,بحر المنسرح,None,None,الأحنف العكبري,10,1, دعوهُ يبكي لفقد خلانه
+None,None,None,None,فصحى,قاسم حداد,10,1,كلمات جندي رهن الاعتقال
+None,None,None,None,None,صلاح الدين الصفدي,10,1,يا سيدا رب العفلا
+None,None,None,None,فصحى,أبو الهدى الصيادي,10,1,بسم ربي باري الوجود ابتدائي