diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md index 7bf7734e..0a5116cf 100644 --- a/docs/webapp/applications/apps_aws_autoscaler.md +++ b/docs/webapp/applications/apps_aws_autoscaler.md @@ -21,23 +21,22 @@ For more information about how autoscalers work, see [Autoscalers Overview](../. ## 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: -* 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. +* 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 the configuration of a previously launched instance as a JSON file +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: -* Click `Launch New` Add new to -open the app's configuration wizard -* Fill in the configuration details listed below +To configure a new app instance, click `Launch New` Add new +to open the app's instance launch form. ### 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 * **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 @@ -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 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 @@ -122,9 +121,9 @@ You can utilize the [configuration vault](../../webapp/webapp_profile.md#configu * `aws_region` * `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 -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 -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. 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 diff --git a/docs/webapp/applications/apps_dashboard.md b/docs/webapp/applications/apps_dashboard.md index 4e8dbf88..26fdd5bc 100644 --- a/docs/webapp/applications/apps_dashboard.md +++ b/docs/webapp/applications/apps_dashboard.md @@ -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. ## 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 * **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: @@ -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 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 diff --git a/docs/webapp/applications/apps_gcp_autoscaler.md b/docs/webapp/applications/apps_gcp_autoscaler.md index 14cb5f80..9b3c61b3 100644 --- a/docs/webapp/applications/apps_gcp_autoscaler.md +++ b/docs/webapp/applications/apps_gcp_autoscaler.md @@ -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). ## 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: -* 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. +* 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 the configuration of a previously launched instance as a JSON file +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: -* Click `Launch New` Add new to -open the app's configuration wizard -* Fill in the configuration details listed below +To configure a new app instance, click `Launch New` Add new +to open the app's instance launch form. ### 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 * **GCP Configuration** * 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 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) @@ -195,11 +194,11 @@ account to configure the autoscaler app: ![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](../../img/apps_gcp_autoscaler_credentials_6a.png) 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) diff --git a/docs/webapp/applications/apps_gradio.md b/docs/webapp/applications/apps_gradio.md index 93ab58fd..69a1ba3c 100644 --- a/docs/webapp/applications/apps_gradio.md +++ b/docs/webapp/applications/apps_gradio.md @@ -38,23 +38,22 @@ Once you start a Gradio launcher instance, you can view the following informatio ## 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: -* 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. +* 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 the configuration of a previously launched instance as a JSON file +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: -* Click `Launch New` Add new to -open the app's configuration wizard -* Fill in the configuration details listed below +To configure a new app instance, click `Launch New` Add new +to open the app's instance launch form. ### 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 * **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 diff --git a/docs/webapp/applications/apps_hpo.md b/docs/webapp/applications/apps_hpo.md index cf5f53fb..a026ad5d 100644 --- a/docs/webapp/applications/apps_hpo.md +++ b/docs/webapp/applications/apps_hpo.md @@ -19,7 +19,7 @@ Control the optimization process with the advanced configuration options, which limits. ## 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 * **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 @@ -74,7 +74,7 @@ limits. * **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 -![HPO app wizard](../../img/apps_hpo_wizard.png) +![HPO app instance launch form](../../img/apps_hpo_wizard.png) ## Dashboard Once an HPO instance is launched, the dashboard displays a summary of the optimization process. diff --git a/docs/webapp/applications/apps_jupyter_lab.md b/docs/webapp/applications/apps_jupyter_lab.md index a2274176..9b2bb33a 100644 --- a/docs/webapp/applications/apps_jupyter_lab.md +++ b/docs/webapp/applications/apps_jupyter_lab.md @@ -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) ## 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: -* 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. +* 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 the configuration of a previously launched instance as a JSON file +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: -* Click `Launch New` Add new to -open the app's configuration wizard -* Fill in the configuration details listed below +To configure a new app instance, click `Launch New` Add new +to open the app's instance launch form. ### 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 * **Git** - To access a git repository remotely, add git information. * Repository diff --git a/docs/webapp/applications/apps_overview.md b/docs/webapp/applications/apps_overview.md index c8fccf0f..4c0436f0 100644 --- a/docs/webapp/applications/apps_overview.md +++ b/docs/webapp/applications/apps_overview.md @@ -40,18 +40,18 @@ Each application's page is split into two sections: ## Launching an App Instance 1. Choose the desired app -1. Click `Launch New` Add new to open the app's configuration wizard +1. Click `Launch New` Add new to open the app's configuration form 1. Fill in the configuration details 1. **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 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. * 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. +The prefilled instance launch form can be edited before starting the new app instance. ::: ## App Instance Actions @@ -74,7 +74,7 @@ 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 +* **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 diff --git a/docs/webapp/applications/apps_streamlit.md b/docs/webapp/applications/apps_streamlit.md index 2628292b..ff54cb6e 100644 --- a/docs/webapp/applications/apps_streamlit.md +++ b/docs/webapp/applications/apps_streamlit.md @@ -38,24 +38,23 @@ Once you start a Streamlit launcher instance, you can view the following informa changes ## 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: -* 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. +* 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 the configuration of a previously launched instance as a JSON file +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: -* Click `Launch New` Add new to -open the app's configuration wizard -* Fill in the configuration details listed below +To configure a new app instance, click `Launch New` Add new +to open the app's instance launch form. ### 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 * **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 diff --git a/docs/webapp/applications/apps_task_scheduler.md b/docs/webapp/applications/apps_task_scheduler.md index 0d1def61..afff467d 100644 --- a/docs/webapp/applications/apps_task_scheduler.md +++ b/docs/webapp/applications/apps_task_scheduler.md @@ -16,7 +16,7 @@ times. ## 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 * **Scheduled Tasks** * **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 a new instance with the same configuration -![TaskScheduler wizard](../../img/apps_taskscheduler_wizard.png) +![TaskScheduler instance launch form](../../img/apps_taskscheduler_wizard.png) ## Dashboard diff --git a/docs/webapp/applications/apps_trigger_manager.md b/docs/webapp/applications/apps_trigger_manager.md index bba4468c..47c26b24 100644 --- a/docs/webapp/applications/apps_trigger_manager.md +++ b/docs/webapp/applications/apps_trigger_manager.md @@ -21,7 +21,7 @@ The app monitors your workspace for trigger events and will launch copies of the ## 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 * **Name** - Name for the app instance. This will appear in the instance list * **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 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 diff --git a/docs/webapp/applications/apps_vscode.md b/docs/webapp/applications/apps_vscode.md index 426c2126..41293c07 100644 --- a/docs/webapp/applications/apps_vscode.md +++ b/docs/webapp/applications/apps_vscode.md @@ -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 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: -* 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. +* 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 the configuration of a previously launched instance as a JSON file +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: -* Click `Launch New` Add new to -open the app's configuration wizard -* Fill in the configuration details listed below +To configure a new app instance, click `Launch New` Add new +to open the app's instance launch form. ### 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 * **Git** - To access a git repository remotely, add git information. * Repository