ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-19 11:41:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit app instance configuration section (#908)

Browse Source
This commit is contained in:
pollfly 2024-08-27 13:59:02 +03:00 committed by GitHub
parent 9231566533
commit 5951d744bf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 78 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/webapp/applications/apps_aws_autoscaler.md
View File

@ -21,23 +21,22 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
## Autoscaler Instance Configuration ## Autoscaler Instance Configuration
When configuring a new AWS Autoscaler instance, you can start from scratch or reuse an existing configuration. When configuring a new AWS Autoscaler instance, you can fill in the required parameters or reuse the configuration of
a previously launched instance.
Launch an app instance with the configuration of a previously launched instance using one of the following options: Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration * Cloning a previously launched app instance will open the instance launch form with the original instance's
prefilled. configuration prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export the configuration of a previously launched instance as a JSON file
viewing its configuration. when viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance: To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to to open the app's instance launch form.
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options ### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **AWS Credentials** - Credentials with which the autoscaler can access your AWS account. See [Generating AWS IAM Credentials](#generating-aws-iam-credentials) * **AWS Credentials** - Credentials with which the autoscaler can access your AWS account. See [Generating AWS IAM Credentials](#generating-aws-iam-credentials)
* Use IAM role - Select if you are running your autoscalers on your own EC2 instances which are attached to an [IAM * Use IAM role - Select if you are running your autoscalers on your own EC2 instances which are attached to an [IAM
@ -110,7 +109,7 @@ and [AWS API Reference: RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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 a new instance with the same configuration
![Autoscaler wizard](../../img/app_aws_autoscaler_wizard.png) ![Autoscaler instance launch form](../../img/app_aws_autoscaler_wizard.png)
### Configuration Vault ### Configuration Vault
@ -122,9 +121,9 @@ You can utilize the [configuration vault](../../webapp/webapp_profile.md#configu
* `aws_region` * `aws_region`
* `aws_credentials_key_id` and `aws_secret_access_key` - AWS credentials for the Autoscaler * `aws_credentials_key_id` and `aws_secret_access_key` - AWS credentials for the Autoscaler
* `extra_vm_bash_script` - A bash script to execute after launching the EC2 instance. This script will be appended to * `extra_vm_bash_script` - A bash script to execute after launching the EC2 instance. This script will be appended to
the one set in the `Init script` field of the autoscaler wizard the one set in the `Init script` field of the instance launch form
* `extra_clearml_conf` - ClearML configuration to use by the ClearML Agent when executing your experiments. This * `extra_clearml_conf` - ClearML configuration to use by the ClearML Agent when executing your experiments. This
configuration will be appended to that set in the `Additional ClearML Configuration` field of the autoscaler wizard configuration will be appended to that set in the `Additional ClearML Configuration` field of the instance launch form
* `files` - Files to create at designated paths with predefined content inside the container running the autoscaler. * `files` - Files to create at designated paths with predefined content inside the container running the autoscaler.
For more information, see [Files Section](../../configs/clearml_conf.md#files-section) For more information, see [Files Section](../../configs/clearml_conf.md#files-section)
* `environment` - Dictionary of environment variables and values to set in the OS environment of the container running * `environment` - Dictionary of environment variables and values to set in the OS environment of the container running

4
docs/webapp/applications/apps_dashboard.md
View File

@ -11,7 +11,7 @@ view of task status and a chosen metric over time, as well as project GPU and wo
on completed/failed Tasks via Slack integration. on completed/failed Tasks via Slack integration.
## Project Dashboard Instance Configuration ## Project Dashboard Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Dashboard Title** - Name of the project dashboard instance, which will appear in the instance list * **Dashboard Title** - Name of the project dashboard instance, which will appear in the instance list
* **Monitoring** - Select what the app instance should monitor. The options are: * **Monitoring** - Select what the app instance should monitor. The options are:
@ -38,7 +38,7 @@ of the chosen metric over time.
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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. a new instance with the same configuration.
![Dashboard app wizard](../../img/apps_dashboard_wizard.png) ![Dashboard app instance launch form](../../img/apps_dashboard_wizard.png)
## Dashboard ## Dashboard

27
docs/webapp/applications/apps_gcp_autoscaler.md
View File

@ -21,23 +21,22 @@ when each VM instance is spun up.
For more information about how autoscalers work, see [Autoscalers Overview](../../cloud_autoscaling/autoscaling_overview.md#autoscaler-applications). For more information about how autoscalers work, see [Autoscalers Overview](../../cloud_autoscaling/autoscaling_overview.md#autoscaler-applications).
## Autoscaler Instance Configuration ## Autoscaler Instance Configuration
When configuring a new GCP Autoscaler instance, you can start from scratch or reuse an existing configuration. When configuring a new GCP Autoscaler instance, you can fill in the required parameters or reuse the configuration of
a previously launched instance.
Launch an app instance with the configuration of a previously launched instance using one of the following options: Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration * Cloning a previously launched app instance will open the instance launch form with the original instance's
prefilled. configuration prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export the configuration of a previously launched instance as a JSON file
viewing its configuration. when viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance: To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to to open the app's instance launch form.
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options ### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **GCP Configuration** * **GCP Configuration**
* GCP Project ID - Project used for spinning up VM instances * GCP Project ID - Project used for spinning up VM instances
@ -101,7 +100,7 @@ open the app's configuration wizard
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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 a new instance with the same configuration
![GCP autoscaler wizard](../../img/apps_gcp_autoscaler_wizard.png) ![GCP autoscaler instance launch form](../../img/apps_gcp_autoscaler_wizard.png)
<a id="configuration_vault"/> <a id="configuration_vault"/>
@ -195,11 +194,11 @@ account to configure the autoscaler app:
![GCP credential key creation](../../img/apps_gcp_autoscaler_credentials_6.png) ![GCP credential key creation](../../img/apps_gcp_autoscaler_credentials_6.png)
1. Go to the GCP Autoscaler wizard **>** open the **GCP Configuration** panel **>** click *Edit* in the 1. Go to the GCP Autoscaler instance launch form **>** open the **GCP Configuration** panel **>** click *Edit* in the
**GCP Credentials** field. **GCP Credentials** field.
![GCP credentials field](../../img/apps_gcp_autoscaler_credentials_6a.png) ![GCP credentials field](../../img/apps_gcp_autoscaler_credentials_6a.png)
Paste the contents of the JSON file from the previous step into the **GCP Credentials** popup. Paste the contents of the JSON file from the previous step into the **GCP Credentials** popup.
![GCP credential wizard input](../../img/apps_gcp_autoscaler_credentials_7.png) ![GCP credential instance launch form input](../../img/apps_gcp_autoscaler_credentials_7.png)

21
docs/webapp/applications/apps_gradio.md
View File

@ -38,23 +38,22 @@ Once you start a Gradio launcher instance, you can view the following informatio
## Gradio Launcher Instance Configuration ## Gradio Launcher Instance Configuration
When configuring a new Gradio launcher instance, you can start from scratch or reuse an existing configuration. When configuring a new Gradio launcher instance, you can fill in the required parameters or reuse the configuration of
a previously launched instance.
Launch an app instance with the configuration of a previously launched instance using one of the following options: Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration * Cloning a previously launched app instance will open the instance launch form with the original instance's
prefilled. configuration prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export the configuration of a previously launched instance as a JSON file
viewing its configuration. when viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance: To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to to open the app's instance launch form.
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options ### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Gradio Instance Name** - Name for the Gradio launcher instance. This will appear in the instance list * **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 * **Project name** - Project where your Gradio launcher app instance task will be stored

4
docs/webapp/applications/apps_hpo.md
View File

@ -19,7 +19,7 @@ Control the optimization process with the advanced configuration options, which
limits. limits.
## HPO Instance Configuration ## HPO Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Initial Task to Optimize** - ID of a ClearML task to optimize. This task will be cloned, and each clone will * **Initial Task to Optimize** - ID of a ClearML task to optimize. This task will be cloned, and each clone will
sample a different set of hyperparameters values sample a different set of hyperparameters values
@ -74,7 +74,7 @@ limits.
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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 a new instance with the same configuration
![HPO app wizard](../../img/apps_hpo_wizard.png) ![HPO app instance launch form](../../img/apps_hpo_wizard.png)
## Dashboard ## Dashboard
Once an HPO instance is launched, the dashboard displays a summary of the optimization process. Once an HPO instance is launched, the dashboard displays a summary of the optimization process.

21
docs/webapp/applications/apps_jupyter_lab.md
View File

@ -28,24 +28,23 @@ Once you have launched an app instance, you can view the following information i
![Jupyter Lab Dashboard](../../img/apps_jupyter_lab.png) ![Jupyter Lab Dashboard](../../img/apps_jupyter_lab.png)
## App Instance Configuration ## App Instance Configuration
When configuring a new Jupyter Lab instance, you can start from scratch or reuse an existing configuration. When configuring a new Jupyter Lab instance, you can fill in the required parameters or reuse the configuration of
a previously launched instance.
Launch an app instance with the configuration of a previously launched instance using one of the following options: Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration * Cloning a previously launched app instance will open the instance launch form with the original instance's
prefilled. configuration prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export the configuration of a previously launched instance as a JSON file
viewing its configuration. when viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance: To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to to open the app's instance launch form.
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options ### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Git** - To access a git repository remotely, add git information. * **Git** - To access a git repository remotely, add git information.
* Repository * Repository

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

@ -40,18 +40,18 @@ Each application's page is split into two sections:
## Launching an App Instance ## Launching an App Instance
1. Choose the desired app 1. Choose the desired app
1. Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the app's configuration wizard 1. Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the app's configuration form
1. Fill in the configuration details 1. Fill in the configuration details
1. **Launch** 1. **Launch**
:::tip Configuration shortcuts :::tip Configuration shortcuts
You can also launch an app instance with the configuration of a previously launched instance: 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 * Cloning a previously launched app instance will open the instance launch form with the original instance's configuration
prefilled. prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration. viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
::: :::
## App Instance Actions ## App Instance Actions
@ -74,7 +74,7 @@ on the instance list header:
![Instance list actions](../../img/apps_instance_list_actions.png) ![Instance list actions](../../img/apps_instance_list_actions.png)
* **Import Configuration** - Import an app instance's configuration file. This opens the app configuration wizard * **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. 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 * **Clear Completed** - Delete all app instances that have completed their execution. This action only

21
docs/webapp/applications/apps_streamlit.md
View File

@ -38,24 +38,23 @@ Once you start a Streamlit launcher instance, you can view the following informa
changes changes
## Streamlit Launcher Instance Configuration ## Streamlit Launcher Instance Configuration
When configuring a new Streamlit launcher instance, you can start from scratch or reuse an existing configuration. When configuring a new Streamlit launcher instance, you can fill in the required parameters or reuse the configuration of
a previously launched instance.
Launch an app instance with the configuration of a previously launched instance using one of the following options: Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration * Cloning a previously launched app instance will open the instance launch form with the original instance's
prefilled. configuration prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export the configuration of a previously launched instance as a JSON file
viewing its configuration. when viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance: To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to to open the app's instance launch form.
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options ### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Streamlit Instance Name** - Name for the Streamlit launcher instance. This will appear in the instance list * **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 * **Project name** - Project where your Streamlit launcher app instance task will be stored

4
docs/webapp/applications/apps_task_scheduler.md
View File

@ -16,7 +16,7 @@ times.
## Scheduler Instance Configuration ## Scheduler Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Scheduled Tasks** * **Scheduled Tasks**
* **Base Task ID** - ID of a ClearML task to clone and enqueue for execution at the specified time. * **Base Task ID** - ID of a ClearML task to clone and enqueue for execution at the specified time.
@ -33,7 +33,7 @@ times.
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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 a new instance with the same configuration
![TaskScheduler wizard](../../img/apps_taskscheduler_wizard.png) ![TaskScheduler instance launch form](../../img/apps_taskscheduler_wizard.png)
## Dashboard ## Dashboard

4
docs/webapp/applications/apps_trigger_manager.md
View File

@ -21,7 +21,7 @@ The app monitors your workspace for trigger events and will launch copies of the
## Trigger Manager Instance Configuration ## Trigger Manager Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Name** - Name for the app instance. This will appear in the instance list * **Name** - Name for the app instance. This will appear in the instance list
* **Triggers** - Events whose occurrence will cause a task to be executed * **Triggers** - Events whose occurrence will cause a task to be executed
@ -52,7 +52,7 @@ The app monitors your workspace for trigger events and will launch copies of the
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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 a new instance with the same configuration
![Trigger manager wizard](../../img/apps_trigger_manager_wizard.png) ![Trigger manager instance launch form](../../img/apps_trigger_manager_wizard.png)
## Dashboard ## Dashboard

21
docs/webapp/applications/apps_vscode.md
View File

@ -28,24 +28,23 @@ Once you have launched an app instance, you can view the following information i
![VS Code Dashboard](../../img/apps_vs_code.png) ![VS Code Dashboard](../../img/apps_vs_code.png)
## VS Code App Instance Configuration ## VS Code App Instance Configuration
When configuring a new VS Code instance, you can start from scratch or reuse an existing configuration. When configuring a new VS Code instance, you can fill in the required parameters or reuse the configuration of
a previously launched instance.
Launch an app instance with the configuration of a previously launched instance using one of the following options: Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration * Cloning a previously launched app instance will open the instance launch form with the original instance's
prefilled. configuration prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when * Importing an app configuration file. You can export the configuration of a previously launched instance as a JSON file
viewing its configuration. when viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance: To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to to open the app's instance launch form.
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options ### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the * **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance values from the file, which can be modified before launching the app instance
* **Git** - To access a git repository remotely, add git information. * **Git** - To access a git repository remotely, add git information.
* Repository * Repository