add usage section

start_app.py

@@ -12,12 +12,33 @@ from huggingface_hub import HfApi, get_token
 
 
 CMD = ["python" ,"run_job.py"]
+ARG_NAMES = ["<src>", "<dst>", "<query>", "[-c config]", "[-s split]", "[-p private]"]
+
+CONTENT = """
+## Usage: 
+
+```bash
+curl -L 'https://huggingface.co/api/jobs/<username>' \
+-H 'Content-Type: application/json' \
+-H 'Authorization: Bearer <hf_token>' \
+-d '{{
+    "spaceId": "{SPACE_ID}", 
+    "command": {CMD},
+    "arguments": {ARG_NAMES},
+    "environment": {{"HF_TOKEN": <hf_token>}},
+    "flavor": "cpu-basic" 
+}}'
+```
+
+## Example:
+"""
 
 with open("README.md") as f:
     METADATA = yaml.safe_load(f.read().split("---\n")[1])
 TITLE = METADATA["title"]
 EMOJI = METADATA["emoji"]
-spaceId = os.environ.get("SPACE_ID") or "lhoestq/run-duckdb"
+SPACE_ID = os.environ.get("SPACE_ID") or "lhoestq/run-duckdb"
+
 
 try:
     process = subprocess.run(CMD + ["--help"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
@@ -75,7 +96,7 @@ def run(src, config, split, dst, query, oauth_token: gr.OAuthToken | None, profi
     resp = requests.post(
         f"https://huggingface.co/api/jobs/{username}",
         json={
-            "spaceId": spaceId,
+            "spaceId": SPACE_ID,
             "arguments": args,
             "command":  CMD,
             "environment": {"HF_TOKEN": token},
@@ -125,6 +146,7 @@ with gr.Blocks() as demo:
             gr.Markdown(f"# {TITLE} {EMOJI}")
         with gr.Column():
             gr.LoginButton()
+    gr.Markdown(CONTENT.format(SPACE_ID=SPACE_ID, CMD=json.dumps(CMD), ARG_NAMES=json.dumps(ARG_NAMES)))
     with gr.Row():
         with gr.Column(scale=10):
             with gr.Row():
@@ -197,7 +219,7 @@ if HELP:
 
 with demo.route("Jobs", "/jobs") as page:
     gr.Markdown("# Jobs")
-    jobs_dataframe = gr.DataFrame()
+    jobs_dataframe = gr.DataFrame(datatype="markdown")
 
     @page.load(outputs=[jobs_dataframe])
     def list_jobs(oauth_token: gr.OAuthToken | None, profile: gr.OAuthProfile | None):
@@ -217,11 +239,12 @@ with demo.route("Jobs", "/jobs") as page:
                 "id": job["metadata"]["id"],
                 "created_at": job["metadata"]["created_at"],
                 "stage": job["compute"]["status"]["stage"],
+                "output": f'[logs](https://huggingface.co/api/jobs/{username}/{job["metadata"]["id"]}/logs-stream)',
                 "command": str(job["compute"]["spec"]["extra"]["command"]),
                 "args": str(job["compute"]["spec"]["extra"]["args"]),
             }
             for job in resp.json()
-            if job["compute"]["spec"]["extra"]["input"]["spaceId"] == spaceId
+            if job["compute"]["spec"]["extra"]["input"]["spaceId"] == SPACE_ID
         ])
 
 if __name__ == "__main__":