instruction

README.md

@@ -11,7 +11,7 @@ pinned: true
 
 ## :hand: Intro
 
-This is a simple string replacement program dedicated for typing logic symbols. Since those symbols are not on our keyboard, typing them is a little bit cumbersome. This tool allows you to type English to get them. Have fun!
+Type English for logic symbols! This is a simple string replacement program dedicated for typing logic symbols. Since those symbols are not on our keyboard, typing them is a little bit cumbersome. This tool allows you to type English to get them. Have fun!
 
 > Permalink: https://huggingface.co/spaces/TIMAX/Logic-Translator
 

app.py

@@ -1,4 +1,8 @@
 import gradio as gr
+from pathlib import Path
+
+
+DESCRIPTION = Path("description.md").read_text(encoding='utf-8')
 
 
 logic_dict = {
@@ -20,8 +24,8 @@ def logic(string: str):
     return processed_string
 
 
-demo = gr.Interface(fn=logic, 
-                    inputs="text", outputs="text", 
+demo = gr.Interface(fn=logic,
+                    inputs="text", outputs="text",
                     examples=[
                         'ALLx (Student(x) IMPLY Smart(x))',
                         'EXISTx (TShirt(x) AND Buy(adam, x))',
@@ -30,8 +34,7 @@ demo = gr.Interface(fn=logic,
                         'ALLx (Project(x) IMPLY (WrittenIn(x, python) XR WrittenIn(x, c++)))'
                     ],
                     title="Logic Translator",
-                    description="Type English for logic symbols!\n∧:AND, ∨:OR, ¬:NOT, ⊕:XR, →:IMPLY, ↔:EQUIV, ∀:ALL, ∃:EXIST (you can input multi-line sentences)",
+                    description=DESCRIPTION,
                     live=True)
 
-demo.launch()
-
+demo.launch(share=True)

description.md

@@ -0,0 +1,28 @@
+## Intro
+
+Type English for logic symbols! This is a simple string replacement program dedicated for typing logic symbols. Since those symbols are not on our keyboard, typing them is a little cumbersome. This tool allows you to type English to get them. Have fun!
+
+## Usage
+
+### Steps
+
+* Input your FOL sentence in the box of **string**. If you want to type a specific logic symbol at some point of your FOL sentence, just type its corresponding tag (uppercase English words) instead, and keep everything else the same. You will find the translation and five examples below.
+* The translation is **real-time**. The result would be shown in the box of **output**.
+* Just copy the result for your need!
+
+### Notice
+
+* Note that you can input **multi-line** sentences!
+* Please don’t include the exact same uppercase spelling of any of the tags in your FOL sentence if you don’t mean it, or the program will replace them without thinking. For example, it your input sentence is: **WALL(berlin wall)** meaning “berlin wall is a wall”, the program output would be **W∀(berlin wall)** with the **ALL** after **W** replaced by **∀**, which is not what you want.
+
+# Translation
+| Logic Symbol |  Tag  |
+| :----------: | :---: |
+|      ∧       |  AND  |
+|      ∨       |  OR   |
+|      ¬       |  NOT  |
+|      ⊕       |  XR   |
+|      →       | IMPLY |
+|      ↔       | EQUIV |
+|      ∀       |  ALL  |
+|      ∃       | EXIST |