ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Gradio and Streamlit apps (#817)

Browse Source
This commit is contained in:
pollfly
2024-04-02 17:19:34 +03:00
committed by GitHub
parent a8b6015f71
commit f5c6d06602
12 changed files with 220 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/webapp/applications/apps_gradio.md Normal file
View File

@@ -0,0 +1,53 @@
---
title: Gradio Launcher
---
:::info Enterprise Feature
The Gradio Launcher App is available under the ClearML Enterprise plan.
:::
[Gradio](https://gradio.app/) is a framework for creating visual web interfaces for your models. The ClearML Gradio
launcher application spins up a Gradio execution environment and serves your Gradio app on a machine of your choice.
Once you start a Gradio launcher instance, you will be provided with an [externally accessible link](#traffic_router) to
your Gradio app, where you can make use of your models.
The Gradio launcher monitors the Gradio app activity and shuts down if it is inactive for a specified maximum idle time.
<a id="traffic_router"/>
:::important Task Traffic Router
The Gradio Launcher relies on the ClearML Traffic Router which facilitates user authentication, and redirects requests
to the IP/port served by the Gradio app.
:::
Once you start a Gradio launcher instance, you can view the following information in its dashboard:
* Gradio App status indicator
* <img src="/docs/latest/icons/ico-gradio-active.svg" alt="Active server" className="icon size-md space-sm" /> - App is running and is actively in use
* <img src="/docs/latest/icons/ico-gradio-loading.svg" alt="Loading server" className="icon size-md space-sm" /> - App is setting up
* <img src="/docs/latest/icons/ico-gradio-idle.svg" alt="Idle server" className="icon size-md space-sm" /> - App is idle
* <img src="/docs/latest/icons/ico-gradio-stopped.svg" alt="Stopped server" className="icon size-md space-sm" /> - App is stopped
* Idle time
* Gradio App - Externally accessible link to your Gradio app. You can send this link to your colleagues, so they can
access the app. Click <img src="/docs/latest/icons/ico-copy-to-clipboard.svg" alt="Copy" className="icon size-sm space-sm" />
to copy link
* Gradio Git repo - Repository that holds the Gradio app script
* Live preview of the Gradio app
* Console Log The console log shows the launcher instance's activity, including server setup progress, server status
changes
## Gradio Launcher Instance Configuration
* **Gradio Instance Name** - Name for the Gradio launcher instance. This will appear in the instance list
* **Project name** - Project where your Gradio launcher app instance task will be stored
* **Task name** - Name of task for your Gradio launcher app instance
* **Git Repository** - Git repository containing the Gradio script
* **Git Branch** - Git branch containing the Gradio script
* **Gradio Script Name** - Name of Gradio script to be executed
* **Queue** - The [ClearML Queue](../../fundamentals/agents_and_queues.md#what-is-a-queue) to which the Gradio launcher
app instance task will be enqueued (make sure an agent is assigned to that queue)
* **Docker Image** - Docker image the ClearML Agent will use for running the Gradio app
* **Arguments** - Arguments to be passed to the script
* **Idle Time Limit** (Hours) - Maximum idle time (Period in which no requests are received by the Gradio app) after
which the Gradio app and the launcher instance will shut down.

2
docs/webapp/applications/apps_overview.md
View File

@@ -20,6 +20,8 @@ ClearML provides the following applications:
* [**Trigger Manager**](apps_trigger_manager.md) - Define tasks to be run when predefined events occur (available under ClearML Enterprise Plan)
* [**Jupyter Lab**](apps_jupyter_lab.md) - Launch a Jupyter Lab session on a remote machine (available under ClearML Enterprise Plan)
* [**VS Code**](apps_vscode.md) - Launch a VS Code session on a remote machine (available under ClearML Enterprise Plan)
* [**Gradio Launcher**](apps_gradio.md) - Create visual web interfaces for your models with Gradio (available under ClearML Enterprise Plan)
* [**Streamlit Launcher**](apps_streamlit.md) - Create visual web interfaces for your models with Streamlit (available under ClearML Enterprise Plan)
:::info Autoscalers
Autoscaling ([GPU Compute](apps_gpu_compute.md), [AWS Autoscaler](apps_aws_autoscaler.md), and [GCP Autoscaler](apps_gcp_autoscaler.md))

53
docs/webapp/applications/apps_streamlit.md Normal file
View File

@@ -0,0 +1,53 @@
---
title: Streamlit Launcher
---
:::info Enterprise Feature
The Streamlit Launcher App is available under the ClearML Enterprise plan.
:::
[Streamlit](https://streamlit.io/) is a framework for creating visual web interfaces for your models. The ClearML Streamlit
launcher application spins up a Streamlit execution environment and serves your Streamlit app on a machine of your choice.
Once you start a Streamlit launcher instance, you will be provided with an [externally accessible link](#traffic_router) to your Streamlit app,
where you can make use of your models.
The Streamlit launcher monitors the Streamlit app activity and shuts down if it is inactive for a specified maximum idle
time.
<a id="traffic_router"/>
:::important Task Traffic Router
The Streamlit Launcher relies on the ClearML Traffic Router which facilitates user authentication, and redirects requests
to the IP/port served by the Streamlit app.
:::
Once you start a Streamlit launcher instance, you can view the following information in its dashboard:
* Streamlit App status indicator
* <img src="/docs/latest/icons/ico-streamlit-active.svg" alt="Active server" className="icon size-md space-sm" /> - App is running and is actively in use
* <img src="/docs/latest/icons/ico-streamlit-loading.svg" alt="Loading server" className="icon size-md space-sm" /> - App is setting up
* <img src="/docs/latest/icons/ico-streamlit-idle.svg" alt="Idle server" className="icon size-md space-sm" /> - App is idle
* <img src="/docs/latest/icons/ico-streamlit-stopped.svg" alt="Stopped server" className="icon size-md space-sm" /> - App is stopped
* Idle time
* Streamlit App - Externally accessible link to your Streamlit app. You can send this link to your colleagues, so they can
access the app. Click <img src="/docs/latest/icons/ico-copy-to-clipboard.svg" alt="Copy" className="icon size-sm space-sm" />
to copy link
* Streamlit Git repo - Repository that holds the Streamlit app script
* Live preview of the Streamlit app
* Console Log The console log shows the launcher instance's activity, including server setup progress, server status
changes
## Streamlit Launcher Instance Configuration
* **Streamlit Instance Name** - Name for the Streamlit launcher instance. This will appear in the instance list
* **Project name** - Project where your Streamlit launcher app instance task will be stored
* **Task name** - Name of task for your Streamlit launcher app instance
* **Git Repository** - Git repository containing the Streamlit script
* **Git Branch** - Git branch containing the Streamlit script
* **Streamlit Script Name** - Name of Streamlit script to be executed
* **Queue** - The [ClearML Queue](../../fundamentals/agents_and_queues.md#what-is-a-queue) to which the Streamlit launcher
app instance task will be enqueued (make sure an agent is assigned to that queue)
* **Docker Image** - Docker image the ClearML Agent will use for running the Streamlit app
* **Arguments** - Arguments to be passed to the script
* **Idle Time Limit** (Hours) - Maximum idle time (Period in which no requests are received by the Streamlit app) after
which the Streamlit app and the launcher instance will shut down.