updated with paper link

app.py

@@ -59,11 +59,11 @@ with gr.Blocks(theme=gr.themes.Default(text_size="lg")) as demo:
 
     gr.Markdown(
     """
-    <img src='https://huggingface.co/spaces/bkhmsi/Partial-Arabic-Diacritization/resolve/main/PartialDD.png' style='float:right; margin: 0 0 10px 10px;'/>
+    <img src='https://huggingface.co/spaces/bkhmsi/Partial-Arabic-Diacritization/resolve/main/PartialDD.png' style='float:right; margin: 0 0 10px 10px; width: 20%'/>
 
     <h1> Partial Diacritization: A Context-Contrastive Inference Approach </h1>
     <h2> Authors: Muhammad ElNokrashy, Badr AlKhamissi </h2>
-    <h3> Paper Link: TBD </h3>
+    <h3> Paper: <a href="https://arxiv.org/abs/2401.08919"> https://arxiv.org/abs/2401.08919 </a> </h3>
     <details>
     <summary>Abstract</summary>
     <p>Diacritization plays a pivotal role in improving readability and disambiguating the meaning of Arabic texts. Efforts have so far focused on marking every eligible character (Full Diacritization). Comparatively overlooked, Partial Diacritzation (PD) is the selection of a subset of characters to be marked to aid comprehension where needed.Research has indicated that excessive diacritic marks can hinder skilled readers---reducing reading speed and accuracy. We conduct a behavioral experiment and show that partially marked text is often easier to read than fully marked text, and sometimes easier than plain text. In this light, we introduce Context-Contrastive Partial Diacritization (CCPD)---a novel approach to PD which integrates seamlessly with existing Arabic diacritization systems. CCPD processes each word twice, once with context and once without, and diacritizes only the characters with disparities between the two inferences. Further, we introduce novel indicators for measuring partial diacritization quality {SR, PDER, HDER, ERE}, essential for establishing this as a machine learning task. Lastly, we introduce TD2, a Transformer-variant of an established model which offers a markedly different performance profile on our proposed indicators compared to all other known systems.</p>
@@ -77,9 +77,12 @@ with gr.Blocks(theme=gr.themes.Default(text_size="lg")) as demo:
         value=current_model_name
     )
     
-    with gr.Tab(label="Full Diacritization"):
-
-        full_input_txt = gr.Textbox(
+    with gr.Tab(label="Partial Diacritization") as partial_settings:
+        with gr.Row():
+            masking_mode = gr.Radio(choices=["Hard", "Soft"], value="Hard", label="Masking Mode")
+            threshold_slider = gr.Slider(label="Soft Masking Threshold", minimum=0, maximum=1, value=0.1)
+        
+        partial_input_txt = gr.Textbox(
             placeholder="اكتب هنا", 
             lines=5, 
             label="Input",
@@ -88,7 +91,7 @@ with gr.Blocks(theme=gr.themes.Default(text_size="lg")) as demo:
             text_align='right',
         )
 
-        full_output_txt = gr.Textbox(
+        partial_output_txt = gr.Textbox(
             lines=5, 
             label="Output",
             type='text',
@@ -97,25 +100,24 @@ with gr.Blocks(theme=gr.themes.Default(text_size="lg")) as demo:
             show_copy_button=True,
         )
 
-        full_btn = gr.Button(value="Shakkel")
-        full_btn.click(diacritze_full, inputs=[full_input_txt, model_choice], outputs=[full_output_txt], queue=True)
+        partial_btn = gr.Button(value="Shakkel")
+        partial_btn.click(diacritze_partial, inputs=[partial_input_txt, masking_mode, threshold_slider, model_choice], outputs=[partial_output_txt], queue=True)
 
         gr.Examples(
             examples=[
-                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "TD2"],
+                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "Hard", 0, "TD2"],
+                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "Soft", 0.1, "TD2"],
+                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "Soft", 0.01, "TD2"],
             ],
-            inputs=[full_input_txt, model_choice],
-            outputs=full_output_txt,
-            fn=diacritze_full,
+            inputs=[partial_input_txt, masking_mode, threshold_slider, model_choice],
+            outputs=partial_output_txt,
+            fn=diacritze_partial,
             cache_examples=True,
         )
 
-    with gr.Tab(label="Partial Diacritization") as partial_settings:
-        with gr.Row():
-            masking_mode = gr.Radio(choices=["Hard", "Soft"], value="Hard", label="Masking Mode")
-            threshold_slider = gr.Slider(label="Soft Masking Threshold", minimum=0, maximum=1, value=0.1)
-        
-        partial_input_txt = gr.Textbox(
+    with gr.Tab(label="Full Diacritization"):
+
+        full_input_txt = gr.Textbox(
             placeholder="اكتب هنا", 
             lines=5, 
             label="Input",
@@ -124,7 +126,7 @@ with gr.Blocks(theme=gr.themes.Default(text_size="lg")) as demo:
             text_align='right',
         )
 
-        partial_output_txt = gr.Textbox(
+        full_output_txt = gr.Textbox(
             lines=5, 
             label="Output",
             type='text',
@@ -133,18 +135,16 @@ with gr.Blocks(theme=gr.themes.Default(text_size="lg")) as demo:
             show_copy_button=True,
         )
 
-        partial_btn = gr.Button(value="Shakkel")
-        partial_btn.click(diacritze_partial, inputs=[partial_input_txt, masking_mode, threshold_slider, model_choice], outputs=[partial_output_txt], queue=True)
+        full_btn = gr.Button(value="Shakkel")
+        full_btn.click(diacritze_full, inputs=[full_input_txt, model_choice], outputs=[full_output_txt], queue=True)
 
         gr.Examples(
             examples=[
-                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "Hard", 0, "TD2"],
-                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "Soft", 0.1, "TD2"],
-                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "Soft", 0.01, "TD2"],
+                ["ولو حمل من مجلس الخيار ، ولم يمنع من الكلام", "TD2"],
             ],
-            inputs=[partial_input_txt, masking_mode, threshold_slider, model_choice],
-            outputs=partial_output_txt,
-            fn=diacritze_partial,
+            inputs=[full_input_txt, model_choice],
+            outputs=full_output_txt,
+            fn=diacritze_full,
             cache_examples=True,
         )