clearml-docs/docs/webapp/applications/apps_overview.md
2024-12-01 11:43:18 +02:00

5.7 KiB

title
ClearML Applications

:::info Pro Plan Offering ClearML Applications are available under the ClearML Pro plan. :::

Use ClearML's GUI Applications to manage ML workloads and automatically run your recurring workflows without any coding.

Apps page

Configure and launch app instances, then track their execution from the app dashboard.

ClearML provides applications in a range of categories to enhance your workflows:

General

Applications for automating and optimizing workflows, and monitoring project performance:

  • Hyperparameter Optimization - Find the parameter values that yield the best performing models
  • Nvidia Clara - Train models using Nvidia's Clara framework
  • Project Dashboard - High-level project monitoring with Slack alerts
  • Task Scheduler - Schedule tasks for one-shot and/or periodic execution at specified times (available under ClearML Enterprise Plan)
  • Trigger Manager - Define tasks to be run when predefined events occur (available under ClearML Enterprise Plan)

AI Dev

Applications for deploying AI development environments on remote machines:

  • SSH Session - Launch a full development environment on a remote machine with a detached interactive SSH session (available under ClearML Enterprise Plan)
  • Jupyter Lab - Launch a Jupyter Lab session on a remote machine (available under ClearML Enterprise Plan)
  • VS Code - Launch a VS Code session on a remote machine (available under ClearML Enterprise Plan)

UI Dev

Applications for deploying user interfaces for models:

  • Gradio Launcher - Create visual web interfaces for your models with Gradio (available under ClearML Enterprise Plan)
  • Streamlit Launcher - Create visual web interfaces for your models with Streamlit (available under ClearML Enterprise Plan)

Deploy

Applications for deploying machine learning models as scalable, secure services:

  • Embedding Model Deployment - Deploy embedding models as networking services over a secure endpoint (available under ClearML Enterprise Plan)
  • Model Deployment - Deploy LLM models as networking services over a secure endpoint (available under ClearML Enterprise Plan)
  • llama.cpp - Deploy LLM models in GGUF format using llama.cpp as networking services over a secure endpoint (available under ClearML Enterprise Plan)

:::info Autoscalers Autoscaling (AWS Autoscaler and GCP Autoscaler) was previously available through the Applications page. The autoscaler functionality has been moved to the Orchestration page in the WebApp. :::

App Pages Layout

Each application's page is split into two sections:

  • App Instance List - Launch new app instances and view previously launched instances. Click on an instance to view its dashboard. Hover over it to access the app instance actions.
  • App Instance Dashboard - The main section of the app page: displays the selected app instance's status and results. Use the search bar Magnifying glass to quickly find an app instance by name.

App format

Launching an App Instance

  1. Choose the desired app
  2. Click Launch New Add new to open the app's configuration form
  3. Fill in the configuration details
  4. Launch

:::tip Configuration shortcuts You can also launch an app instance with the configuration of a previously launched instance:

  • Cloning a previously launched app instance will open the instance launch form with the original instance's configuration prefilled.
  • Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when viewing its configuration.

The prefilled instance launch form can be edited before starting the new app instance. :::

App Instance Actions

Access app instance actions, by right-clicking an instance, or through the menu button Dot menu (available on hover).

App context menu

  • Rename - Rename the instance
  • Configuration - View an instance's configuration
  • Export Configuration - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration
  • Stop - Shutdown the instance
  • Clone - Launch a new instance with same configuration prefilled
  • Delete - Delete the instance

Instance List Actions

Access the instance list actions by clicking the action menu (Dot menu) on the instance list header:

Instance list actions

  • Import Configuration - Import an app instance's configuration file. This opens the app instance launch form prefilled according to the imported file. You can modify the configuration before launching the instance.

  • Clear Completed - Delete all app instances that have completed their execution. This action only deletes instances in the current instance list view (i.e. My instances / All).