Add result example files, note how to call the API

app.py

@@ -315,14 +315,60 @@ app_description = (
     Enter a name, click Submit, and wait for about 4 minutes to see the result.
     """).strip()
 input_box = gr.Textbox(label="Enter a monster name", placeholder="Jabberwock")
-output_monster_card = gr.Image(label="Monster Card", type='pil')
-output_text_box = gr.Textbox(label="Monster Text")
-output_monster_image = gr.Image(label="Monster Image", type='pil')
+output_monster_card = gr.Image(label="Monster Card", type='pil', value="examples/jabberwock_card.png")
+output_text_box = gr.Textbox(label="Monster Text", value=pathlib.Path("examples/jabberwock.txt").read_text('utf-8'))
+output_monster_image = gr.Image(label="Monster Image", type='pil', value="examples/jabberwock.png")
 output_monster_html = gr.HTML(label="Monster HTML", visible=False, show_label=False)
 x = gr.components.Textbox()
 iface = gr.Interface(title="MonsterGen", theme="default", description=app_description, fn=run, inputs=[input_box],
                      outputs=[output_monster_card, output_text_box, output_monster_image, output_monster_html])
 iface.launch()
-# https://gradio.app/sharing_your_app/#api-page
-# Looks like API page improvements are in progress: https://github.com/gradio-app/gradio/issues/1325
 # TODO: Add examples
+# API works, assuming query takes no longer than 30 seconds (504 gateway timeout)
+# Looks like API page improvements are in progress: https://github.com/gradio-app/gradio/issues/1325
+# Example code below:
+# import requests
+# r = requests.post(url='https://hf.space/embed/gstaff/test_space/+/api/predict', json={"data": [""]},
+#                   timeout=None)
+# print(r.json())
+
+# Looks like Huggingface uses the queue push api, then polls for status:
+# fetch("https://hf.space/embed/gstaff/test_space/api/queue/push/", {
+#   "headers": {
+#     "accept": "*/*",
+#     "accept-language": "en-US,en;q=0.9",
+#     "content-type": "application/json",
+#     "sec-ch-ua": "\".Not/A)Brand\";v=\"99\", \"Google Chrome\";v=\"103\", \"Chromium\";v=\"103\"",
+#     "sec-ch-ua-mobile": "?0",
+#     "sec-ch-ua-platform": "\"Windows\"",
+#     "sec-fetch-dest": "empty",
+#     "sec-fetch-mode": "cors",
+#     "sec-fetch-site": "same-origin"
+#   },
+#   "referrer": "https://hf.space/embed/gstaff/test_space/+?__theme=light",
+#   "referrerPolicy": "strict-origin-when-cross-origin",
+#   "body": "{\"fn_index\":0,\"data\":[\"Jabberwock\"],\"action\":\"predict\",\"session_hash\":\"v9ehgfho3p\"}",
+#   "method": "POST",
+#   "mode": "cors",
+#   "credentials": "omit"
+# });
+
+# fetch("https://hf.space/embed/gstaff/test_space/api/queue/status/", {
+#   "headers": {
+#     "accept": "*/*",
+#     "accept-language": "en-US,en;q=0.9",
+#     "content-type": "application/json",
+#     "sec-ch-ua": "\".Not/A)Brand\";v=\"99\", \"Google Chrome\";v=\"103\", \"Chromium\";v=\"103\"",
+#     "sec-ch-ua-mobile": "?0",
+#     "sec-ch-ua-platform": "\"Windows\"",
+#     "sec-fetch-dest": "empty",
+#     "sec-fetch-mode": "cors",
+#     "sec-fetch-site": "same-origin"
+#   },
+#   "referrer": "https://hf.space/embed/gstaff/test_space/+?__theme=light",
+#   "referrerPolicy": "strict-origin-when-cross-origin",
+#   "body": "{\"hash\":\"09f5369a7a414169aa48948bad5fd93d\"}",
+#   "method": "POST",
+#   "mode": "cors",
+#   "credentials": "omit"
+# });

examples/jabberwock.txt

@@ -0,0 +1,25 @@
+Name: Jabberwock
+Type: Medium humanoid (human), neutral evil
+Description: A Jabberwock is a creature of the Deep Sea.
+
+Stats:
+Armor Class: 15 (breastplate)
+Hit Points: 22 (5d8 + 5)
+Speed: 30 ft
+STR: 8 (-1)
+DEX: 14 (+2)
+CON: 12 (+1)
+INT: 2 (-4)
+WIS: 10 (+0)
+CHA: 4 (-3)
+Skills: Perception +3
+Senses: darkvision 60 ft., passive Perception 14
+Languages: —
+Challenge: 1/4 (50 XP)
+
+Passives:
+Legendary Resistance (3/Day): If the Jabberwock fails a saving throw, it can choose to succeed instead
+
+Actions:
+Bite: Melee Weapon Attack: +5 to hit, reach 5 ft., one target. Hit: 6 (1d8 + 3) piercing damage.
+Claws (Recharge 5-6): Melee Weapon Attack: +5 to hit, reach 5 ft., one target. Hit: 6 (1d10 + 3) slashing damage.