clearml-docs/docs/webapp/applications/apps_overview.md

77 lines
3.9 KiB
Markdown
Raw Normal View History

2022-08-03 09:15:15 +00:00
---
title: Overview
---
:::info Pro Plan Offering
ClearML Applications are available under the ClearML Pro plan
:::
Use ClearMLs GUI Applications to manage ML workloads and automatically run your recurring workflows without any coding.
![Apps page](../../img/apps_overview_page.png)
Configure and launch app instances, then track their execution from the app dashboard.
ClearML provides the following applications:
* [**GPU Compute**](apps_gpu_compute.md) - Launch cloud machines on demand and optimize their usage according to a
defined budget--no previous setup necessary
2022-08-03 09:15:15 +00:00
* [**AWS Autoscaler**](apps_aws_autoscaler.md) - Optimize AWS EC2 instance usage according to a defined instance budget
2023-01-25 11:25:29 +00:00
* [**GCP Autoscaler**](apps_gcp_autoscaler.md) - Optimize GCP instance usage according to a defined instance budget
2022-08-07 07:31:16 +00:00
* [**Hyperparameter Optimization**](apps_hpo.md) - Find the parameter values that yield the best performing models
2022-08-03 09:15:15 +00:00
* **Nvidia Clara** - Train models using Nvidias Clara framework
2022-08-07 07:31:16 +00:00
* [**Project Dashboard**](apps_dashboard.md) - High-level project monitoring with Slack alerts
* [**Task Scheduler**](apps_task_scheduler.md) - Schedule tasks for one-shot and/or periodic execution at specified times (available under ClearML Enterprise Plan)
2023-06-11 07:13:08 +00:00
* [**Trigger Manager**](apps_trigger_manager) - Define tasks to be run when predefined events occur (available under ClearML Enterprise Plan)
2022-08-03 09:15:15 +00:00
## App Pages Layout
Each applications 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-actions).
* App Instance Dashboard - The main section of the app page: displays the selected app instances status and results.
![App format](../../img/apps_format_overview.png)
## Launching an App Instance
1. Choose the desired app
1. Click the `Launch New` button <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the apps configuration wizard
1. Fill in the configuration details
1. **Launch**
2022-09-15 13:10:11 +00:00
:::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 launch wizard 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 configuration wizard can be edited before launching the new app instance.
:::
2022-08-03 09:15:15 +00:00
## App Instance Actions
2022-12-26 09:08:10 +00:00
Access app instance actions, by right-clicking an instance, or through the menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> (available on hover).
2022-08-03 09:15:15 +00:00
![App context menu](../../img/app_context_menu.png)
* **Rename** - Rename the instance
* **Configuration** - View an instances configuration
2022-09-15 13:10:11 +00:00
* **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
2022-08-03 09:15:15 +00:00
* **Stop** - Shutdown the instance
* **Clone** - Launch a new instance with same configuration prefilled
* **Delete** - Delete the instance
2022-09-15 13:10:11 +00:00
## Instance List Actions
Access the instance list actions by clicking the action menu ( <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> )
on the instance list header:
![Instance list actions](../../img/apps_instance_list_actions.png)
* **Import Configuration** - Import an app instance's configuration file. This opens the app configuration wizard
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).