added description to demo

.ipynb_checkpoints/app-checkpoint.ipynb

@@ -194,7 +194,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 1,
    "id": "42242b57-3569-46f2-9966-c737dd6e6f16",
    "metadata": {},
    "outputs": [],
@@ -204,30 +204,29 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 2,
    "id": "4e41db23-e369-413d-ab25-f85cd21af0c4",
    "metadata": {},
-   "outputs": [],
-   "source": [
-    "import gradio as gr"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "411ef985-d45e-4b17-b33c-24fde7c00b4f",
-   "metadata": {},
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
       "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/tqdm/auto.py:21: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
-      "  from .autonotebook import tqdm as notebook_tqdm\n",
-      "Matplotlib is building the font cache; this may take a moment.\n"
+      "  from .autonotebook import tqdm as notebook_tqdm\n"
      ]
     }
    ],
+   "source": [
+    "import gradio as gr"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "411ef985-d45e-4b17-b33c-24fde7c00b4f",
+   "metadata": {},
+   "outputs": [],
    "source": [
     "#import gradio as gr\n",
     "from autogluon.text import TextPredictor"
@@ -235,7 +234,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 4,
    "id": "7de002b3-e67f-46b9-95d1-e07a1bea7f5a",
    "metadata": {},
    "outputs": [],
@@ -246,7 +245,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
+   "execution_count": 5,
    "id": "d3093469-f35f-4008-9da4-340c64a9f85a",
    "metadata": {},
    "outputs": [],
@@ -261,18 +260,42 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 27,
+   "execution_count": 40,
+   "id": "873463fb-4911-4fe3-8f1f-36fa4c03f8a1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "description_text = \"\"\"\n",
+    "This [model](https://huggingface.co/manifesto-project/manifestoberta-xlm-roberta-56policy-topics-sentence-2023-1-1) was trained on over 8000 German tweets. The label definitions can be found in this [handbook](https://manifesto-project.wzb.eu/coding_schemes/mp_v4) from the Manifesto Project.\n",
+    "\n",
+    "With this app you can classify statements into political topics like this:\n",
+    "\n",
+    "1. Enter some text in the input box.\n",
+    "2. Click 'Submit' or press 'Enter' to get the classification result.\n",
+    "3. If you want to know the label's definition, look it up [here](https://manifesto-project.wzb.eu/coding_schemes/mp_v4).\n",
+    "\"\"\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 41,
    "id": "8e2ad81f-5b87-47c1-a60a-fd45616e8fb0",
    "metadata": {},
    "outputs": [],
    "source": [
     "# Create a Gradio interface\n",
-    "demo = gr.Interface(fn=classify_text, inputs=\"text\", outputs=\"label\", title=\"AutoGluon Text Classification Demo\")"
+    "demo = gr.Interface(\n",
+    "    fn=classify_text,\n",
+    "    inputs=\"text\",\n",
+    "    outputs=\"label\",\n",
+    "    title=\"Manifestoberta fine-tuned on Politweets\",\n",
+    "    description=description_text\n",
+    ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 28,
+   "execution_count": 42,
    "id": "18d88162-30cc-4a6b-8581-793ed65aef0f",
    "metadata": {},
    "outputs": [
@@ -280,7 +303,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Running on local URL:  http://127.0.0.1:7861\n",
+      "Running on local URL:  http://127.0.0.1:7873\n",
       "\n",
       "To create a public link, set `share=True` in `launch()`.\n"
      ]
@@ -288,7 +311,7 @@
     {
      "data": {
       "text/html": [
-       "<div><iframe src=\"http://127.0.0.1:7861/\" width=\"100%\" height=\"500\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
+       "<div><iframe src=\"http://127.0.0.1:7873/\" width=\"100%\" height=\"500\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
       ],
       "text/plain": [
        "<IPython.core.display.HTML object>"
@@ -301,39 +324,108 @@
      "data": {
       "text/plain": []
      },
-     "execution_count": 28,
+     "execution_count": 42,
      "metadata": {},
      "output_type": "execute_result"
-    },
+    }
+   ],
+   "source": [
+    "# Launch the app\n",
+    "demo.launch()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3123914a-a490-4395-917b-1ef5c1056c57",
+   "metadata": {},
+   "source": [
+    "## More Customization\n",
+    "This is probably the way to go if I want more functionality and control.\n",
+    "But for now I don't really want to get into that stuff."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "id": "5f37d50d-281b-42a8-bcc3-26cc27b54507",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with gr.Blocks() as demo:\n",
+    "    gr.Interface(\n",
+    "    fn=classify_text,\n",
+    "    inputs=\"text\",\n",
+    "    outputs=\"label\"\n",
+    "    )\n",
+    "\n",
+    "    # Add explanation at the top using Markdown\n",
+    "    gr.Markdown(\"\"\"\n",
+    "    ### AutoGluon Text Classification Demo\n",
+    "    \n",
+    "    This app classifies text using a model trained with AutoGluon. \n",
+    "    To use the app:\n",
+    "    1. Enter your text in the input box below.\n",
+    "    2. Click the 'Submit' button to get the classification result.\n",
+    "    \n",
+    "    For more details, visit [AutoGluon Documentation](https://auto.gluon.ai/stable/index.html).\n",
+    "    \"\"\")\n",
+    "    \n",
+    "    # Add input, output, and button\n",
+    "    text_input = gr.Textbox(label=\"Enter your text\")\n",
+    "    output = gr.Label(label=\"Classification\")\n",
+    "    submit_btn = gr.Button(\"Submit\")\n",
+    "\n",
+    "    # Link the button to the function\n",
+    "    submit_btn.click(classify_text, inputs=text_input, outputs=output)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 23,
+   "id": "8652a1b0-8f65-4983-8bdd-a57117fee5da",
+   "metadata": {},
+   "outputs": [
     {
-     "name": "stderr",
+     "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n"
+      "Running on local URL:  http://127.0.0.1:7866\n",
+      "\n",
+      "To create a public link, set `share=True` in `launch()`.\n"
      ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div><iframe src=\"http://127.0.0.1:7866/\" width=\"100%\" height=\"500\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
+      ],
+      "text/plain": [
+       "<IPython.core.display.HTML object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/plain": []
+     },
+     "execution_count": 23,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
-    "# Launch the app\n",
     "demo.launch()"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f245aa88-4746-4aed-85c1-a09bdcbb6710",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {

app.ipynb

@@ -194,7 +194,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 1,
    "id": "42242b57-3569-46f2-9966-c737dd6e6f16",
    "metadata": {},
    "outputs": [],
@@ -204,30 +204,29 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 2,
    "id": "4e41db23-e369-413d-ab25-f85cd21af0c4",
    "metadata": {},
-   "outputs": [],
-   "source": [
-    "import gradio as gr"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "411ef985-d45e-4b17-b33c-24fde7c00b4f",
-   "metadata": {},
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
       "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/tqdm/auto.py:21: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
-      "  from .autonotebook import tqdm as notebook_tqdm\n",
-      "Matplotlib is building the font cache; this may take a moment.\n"
+      "  from .autonotebook import tqdm as notebook_tqdm\n"
      ]
     }
    ],
+   "source": [
+    "import gradio as gr"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "411ef985-d45e-4b17-b33c-24fde7c00b4f",
+   "metadata": {},
+   "outputs": [],
    "source": [
     "#import gradio as gr\n",
     "from autogluon.text import TextPredictor"
@@ -235,7 +234,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 4,
    "id": "7de002b3-e67f-46b9-95d1-e07a1bea7f5a",
    "metadata": {},
    "outputs": [],
@@ -246,7 +245,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
+   "execution_count": 5,
    "id": "d3093469-f35f-4008-9da4-340c64a9f85a",
    "metadata": {},
    "outputs": [],
@@ -261,18 +260,42 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 27,
+   "execution_count": 40,
+   "id": "873463fb-4911-4fe3-8f1f-36fa4c03f8a1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "description_text = \"\"\"\n",
+    "This [model](https://huggingface.co/manifesto-project/manifestoberta-xlm-roberta-56policy-topics-sentence-2023-1-1) was trained on over 8000 German tweets. The label definitions can be found in this [handbook](https://manifesto-project.wzb.eu/coding_schemes/mp_v4) from the Manifesto Project.\n",
+    "\n",
+    "With this app you can classify statements into political topics like this:\n",
+    "\n",
+    "1. Enter some text in the input box.\n",
+    "2. Click 'Submit' or press 'Enter' to get the classification result.\n",
+    "3. If you want to know the label's definition, look it up [here](https://manifesto-project.wzb.eu/coding_schemes/mp_v4).\n",
+    "\"\"\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 41,
    "id": "8e2ad81f-5b87-47c1-a60a-fd45616e8fb0",
    "metadata": {},
    "outputs": [],
    "source": [
     "# Create a Gradio interface\n",
-    "demo = gr.Interface(fn=classify_text, inputs=\"text\", outputs=\"label\", title=\"AutoGluon Text Classification Demo\")"
+    "demo = gr.Interface(\n",
+    "    fn=classify_text,\n",
+    "    inputs=\"text\",\n",
+    "    outputs=\"label\",\n",
+    "    title=\"Manifestoberta fine-tuned on Politweets\",\n",
+    "    description=description_text\n",
+    ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 28,
+   "execution_count": 42,
    "id": "18d88162-30cc-4a6b-8581-793ed65aef0f",
    "metadata": {},
    "outputs": [
@@ -280,7 +303,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Running on local URL:  http://127.0.0.1:7861\n",
+      "Running on local URL:  http://127.0.0.1:7873\n",
       "\n",
       "To create a public link, set `share=True` in `launch()`.\n"
      ]
@@ -288,7 +311,7 @@
     {
      "data": {
       "text/html": [
-       "<div><iframe src=\"http://127.0.0.1:7861/\" width=\"100%\" height=\"500\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
+       "<div><iframe src=\"http://127.0.0.1:7873/\" width=\"100%\" height=\"500\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
       ],
       "text/plain": [
        "<IPython.core.display.HTML object>"
@@ -301,39 +324,108 @@
      "data": {
       "text/plain": []
      },
-     "execution_count": 28,
+     "execution_count": 42,
      "metadata": {},
      "output_type": "execute_result"
-    },
+    }
+   ],
+   "source": [
+    "# Launch the app\n",
+    "demo.launch()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3123914a-a490-4395-917b-1ef5c1056c57",
+   "metadata": {},
+   "source": [
+    "## More Customization\n",
+    "This is probably the way to go if I want more functionality and control.\n",
+    "But for now I don't really want to get into that stuff."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "id": "5f37d50d-281b-42a8-bcc3-26cc27b54507",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with gr.Blocks() as demo:\n",
+    "    gr.Interface(\n",
+    "    fn=classify_text,\n",
+    "    inputs=\"text\",\n",
+    "    outputs=\"label\"\n",
+    "    )\n",
+    "\n",
+    "    # Add explanation at the top using Markdown\n",
+    "    gr.Markdown(\"\"\"\n",
+    "    ### AutoGluon Text Classification Demo\n",
+    "    \n",
+    "    This app classifies text using a model trained with AutoGluon. \n",
+    "    To use the app:\n",
+    "    1. Enter your text in the input box below.\n",
+    "    2. Click the 'Submit' button to get the classification result.\n",
+    "    \n",
+    "    For more details, visit [AutoGluon Documentation](https://auto.gluon.ai/stable/index.html).\n",
+    "    \"\"\")\n",
+    "    \n",
+    "    # Add input, output, and button\n",
+    "    text_input = gr.Textbox(label=\"Enter your text\")\n",
+    "    output = gr.Label(label=\"Classification\")\n",
+    "    submit_btn = gr.Button(\"Submit\")\n",
+    "\n",
+    "    # Link the button to the function\n",
+    "    submit_btn.click(classify_text, inputs=text_input, outputs=output)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 23,
+   "id": "8652a1b0-8f65-4983-8bdd-a57117fee5da",
+   "metadata": {},
+   "outputs": [
     {
-     "name": "stderr",
+     "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n",
-      "Global seed set to 123\n",
-      "/Users/macbook/.pyenv/versions/politvenv/lib/python3.10/site-packages/autogluon/multimodal/utils/environment.py:50: UserWarning: Using the detected GPU number 0, smaller than the GPU number 1 in the config.\n",
-      "  warnings.warn(\n"
+      "Running on local URL:  http://127.0.0.1:7866\n",
+      "\n",
+      "To create a public link, set `share=True` in `launch()`.\n"
      ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div><iframe src=\"http://127.0.0.1:7866/\" width=\"100%\" height=\"500\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
+      ],
+      "text/plain": [
+       "<IPython.core.display.HTML object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/plain": []
+     },
+     "execution_count": 23,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
-    "# Launch the app\n",
     "demo.launch()"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f245aa88-4746-4aed-85c1-a09bdcbb6710",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {

app.py

@@ -10,9 +10,25 @@ def classify_text(text):
     single_row = pd.DataFrame([text], columns=["text"])
     prediction = predictor.predict(single_row)
     return prediction[0]
+
+description_text = """
+This [model](https://huggingface.co/manifesto-project/manifestoberta-xlm-roberta-56policy-topics-sentence-2023-1-1) was trained on over 8000 German tweets. The label definitions can be found in this [handbook](https://manifesto-project.wzb.eu/coding_schemes/mp_v4) from the Manifesto Project.
+
+With this app you can classify statements into political topics like this:
+
+1. Enter some text in the input box.
+2. Click 'Submit' or press 'Enter' to get the classification result.
+3. If you want to know the label's definition, look it up [here](https://manifesto-project.wzb.eu/coding_schemes/mp_v4).
+"""
     
 # Create a Gradio interface
-demo = gr.Interface(fn=classify_text, inputs="text", outputs="label", title="AutoGluon Text Classification Demo")
+demo = gr.Interface(
+    fn=classify_text,
+    inputs="text",
+    outputs="label",
+    title="Manifestoberta fine-tuned on Politweets",
+    description=description_text
+)
 
 # Launch the app
 demo.launch()