Added README, updated instructions

README.md

@@ -9,4 +9,37 @@ app_file: eng_to_aslGloss_app.py
 pinned: false
 ---
 # How to use English to ASL Gloss
+
+### Introduction
+
+This is a program that uses GPT4 to translate English text to ASL gloss.
+This program makes use of prompt engineering to first describe the task it wants GPT4 to complete (along with examples of translations of English text and it's ASL gloss translations), and then providing GPT4 with the English text to translate to ASL_gloss.
+
+These prompts are included as part of the package.
+
+### Requirements
+
+This program makes use of the following packages:
+- Python 10 environment (required for tiktoken and openAI)
+- openAI
+- tiktoken
+- openAI key and access to GPT4
+
+### Limitations
+
+- Token length
+  - GPT4 has a token limit, and our prompting uses a lot of the allocated tokens.  As a result, your text must be shorter than 553 tokens.  If your text is longer than that, program will not translate your text.  (The program will calculate tokens for you, so you don't need to worry about doing that conversion)
+    - If/when this limit changes, we will update the program to better handle longer texts
+  
+- Speed and Cost
+  - Be aware that each time we run this code, it re-prompts GPT4 (since we can't save our models).  As a result, it takes a little time and it costs a little bit of money.  But it's not too bad.
+  
+- Imperfect ASL gloss
+  - Although this does a pretty good job, it's not perfect ASL gloss
+  - Some things you should watch for include:
+    - word order
+    - fingerspelling
+    - formatting rules <>
+  - As we continue to improve the prompting, we will update with any new prompts that we create that improve the ASL gloss output.
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

eng_to_aslGloss_app.py

@@ -93,12 +93,10 @@ def main():
     
     title = "English to ASL Gloss"
     #description = """Translate English text to ASL Gloss"""
-    description = "This program uses GPT4 to translate English text to \
-        ASL gloss. This program makes use of prompt engineering to first describe\
-        the task it wants GPT4 to complete (along with examples of translations\
-        of English text and it's ASL gloss translations), and then providing\
-        GPT4 with the English text to translate to ASL_gloss.  Using these prompts,\
-        GPT4 translates the input text into ASL gloss."
+    description = "This program uses GPT4 alongside prompt engineering to \
+        translate English text to ASL gloss.\n \
+        Type in the English sentence you would like to translate into ASL Gloss. \
+        \n For additional details on how the program works, please see the README.md"
 
     interface = gr.Interface(
         fn=getGlossFromText, 
@@ -106,7 +104,7 @@ def main():
         outputs="text",
         title = title,
         description = description,
-        examples = [[("Every year I buy my dad a gift", "EVERY-YEAR<Ti>, MY DAD GIFT<T>, ME BUY<A>")]])
+        examples = [[("Every year I buy my dad a gift", "  EVERY-YEAR<Ti>, MY DAD GIFT<T>, ME BUY<A>")]])
         # examples=[["Every year I buy my dad a gift"], ["I always look forward to the family vacation"], 
         #         ["If I don't travel often, I am sad."]])
     interface.launch()