From bc6f88ccc6b389a5649d47e3184967948ae170aa Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Mon, 19 Aug 2024 14:42:12 +0300 Subject: [PATCH] Add app configuration shortcut info (#904) --- .../applications/apps_aws_autoscaler.md | 17 ++++++++++++++ .../applications/apps_gcp_autoscaler.md | 16 +++++++++++++ docs/webapp/applications/apps_gradio.md | 21 ++++++++++++++++- docs/webapp/applications/apps_jupyter_lab.md | 23 +++++++++++++++++-- docs/webapp/applications/apps_overview.md | 2 +- docs/webapp/applications/apps_streamlit.md | 22 +++++++++++++++++- .../applications/apps_task_scheduler.md | 4 ++++ .../applications/apps_trigger_manager.md | 4 ++++ docs/webapp/applications/apps_vscode.md | 20 ++++++++++++++++ 9 files changed, 124 insertions(+), 5 deletions(-) diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md index 867e89b0..7bf7734e 100644 --- a/docs/webapp/applications/apps_aws_autoscaler.md +++ b/docs/webapp/applications/apps_aws_autoscaler.md @@ -20,6 +20,23 @@ each 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 AWS Autoscaler instance, you can start from scratch or reuse an existing configuration. + +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. + +The prefilled configuration wizard can be edited before launching 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 + +### Configuration Options * **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard 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) diff --git a/docs/webapp/applications/apps_gcp_autoscaler.md b/docs/webapp/applications/apps_gcp_autoscaler.md index cf5b5fb3..14cb5f80 100644 --- a/docs/webapp/applications/apps_gcp_autoscaler.md +++ b/docs/webapp/applications/apps_gcp_autoscaler.md @@ -21,6 +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. + +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. + +The prefilled configuration wizard can be edited before launching 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 + +### Configuration Options * **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the values from the file, which can be modified before launching the app instance * **GCP Configuration** diff --git a/docs/webapp/applications/apps_gradio.md b/docs/webapp/applications/apps_gradio.md index b1e2e539..93ab58fd 100644 --- a/docs/webapp/applications/apps_gradio.md +++ b/docs/webapp/applications/apps_gradio.md @@ -38,7 +38,24 @@ 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. +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. + +The prefilled configuration wizard can be edited before launching 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 + +### Configuration Options +* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard 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 * **Task name** - Name of task for your Gradio launcher app instance @@ -50,4 +67,6 @@ Once you start a Gradio launcher instance, you can view the following informatio * **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. \ No newline at end of file + which the Gradio app and the launcher instance will shut down. +* **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 \ No newline at end of file diff --git a/docs/webapp/applications/apps_jupyter_lab.md b/docs/webapp/applications/apps_jupyter_lab.md index 92ee0a21..a2274176 100644 --- a/docs/webapp/applications/apps_jupyter_lab.md +++ b/docs/webapp/applications/apps_jupyter_lab.md @@ -27,8 +27,26 @@ Once you have launched an app instance, you can view the following information i ![Jupyter Lab Dashboard](../../img/apps_jupyter_lab.png) -## Extra Python packages to be installedApp Instance Configuration +## App Instance Configuration +When configuring a new Jupyter Lab instance, you can start from scratch or reuse an existing configuration. +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. + +The prefilled configuration wizard can be edited before launching 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 + +### Configuration Options + +* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard 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 * Branch @@ -44,5 +62,6 @@ Once you have launched an app instance, you can view the following information i * Idle Network Threshold (MB/s) - Throughput under which the session will be considered idle * Idle CPU Threshold (%) - CPU utilization under which the session will be considered idle * Idle GPU Threshold (%) - GPU utilization under which the session will be considered idle - +* **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 diff --git a/docs/webapp/applications/apps_overview.md b/docs/webapp/applications/apps_overview.md index d3f963ed..c8fccf0f 100644 --- a/docs/webapp/applications/apps_overview.md +++ b/docs/webapp/applications/apps_overview.md @@ -40,7 +40,7 @@ Each application's page is split into two sections: ## Launching an App Instance 1. Choose the desired app -1. Click the `Launch New` button Add new to open the app's configuration wizard +1. Click `Launch New` Add new to open the app's configuration wizard 1. Fill in the configuration details 1. **Launch** diff --git a/docs/webapp/applications/apps_streamlit.md b/docs/webapp/applications/apps_streamlit.md index 9807599e..2628292b 100644 --- a/docs/webapp/applications/apps_streamlit.md +++ b/docs/webapp/applications/apps_streamlit.md @@ -38,7 +38,25 @@ 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. +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. + +The prefilled configuration wizard can be edited before launching 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 + +### Configuration Options + +* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard 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 * **Task name** - Name of task for your Streamlit launcher app instance @@ -50,4 +68,6 @@ Once you start a Streamlit launcher instance, you can view the following informa * **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. \ No newline at end of file + which the Streamlit app and the launcher instance will shut down. +* **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 \ No newline at end of file diff --git a/docs/webapp/applications/apps_task_scheduler.md b/docs/webapp/applications/apps_task_scheduler.md index e5dd60d4..0d1def61 100644 --- a/docs/webapp/applications/apps_task_scheduler.md +++ b/docs/webapp/applications/apps_task_scheduler.md @@ -16,6 +16,8 @@ times. ## Scheduler Instance Configuration +* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard 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. * **Destination Project** - The project where the task will be cloned to. @@ -28,6 +30,8 @@ times. * **Time of the Day** - The time(s) (UTC) at which the task should run * **Add item** - Add another task to schedule * **Scheduling Job Name** - Name for the Scheduler instance. This will appear in the instance list +* **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) diff --git a/docs/webapp/applications/apps_trigger_manager.md b/docs/webapp/applications/apps_trigger_manager.md index 3791e976..bba4468c 100644 --- a/docs/webapp/applications/apps_trigger_manager.md +++ b/docs/webapp/applications/apps_trigger_manager.md @@ -21,6 +21,8 @@ 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 + 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 * Task ID - ID of a ClearML task to clone and enqueue @@ -47,6 +49,8 @@ The app monitors your workspace for trigger events and will launch copies of the * Threshold - The metric threshold to monitor * Add item - Add another trigger * **Polling frequency** - Time period in minutes at which the workspace is polled for trigger events +* **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) diff --git a/docs/webapp/applications/apps_vscode.md b/docs/webapp/applications/apps_vscode.md index d377e3b3..426c2126 100644 --- a/docs/webapp/applications/apps_vscode.md +++ b/docs/webapp/applications/apps_vscode.md @@ -28,7 +28,25 @@ 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. +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. + +The prefilled configuration wizard can be edited before launching 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 + +### Configuration Options + +* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard 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 * Branch @@ -45,5 +63,7 @@ Once you have launched an app instance, you can view the following information i * Idle Network Threshold (MB/s) - Throughput under which the session will be considered idle * Idle CPU Threshold (%) - CPU utilization under which the session will be considered idle * Idle GPU Threshold (%) - GPU utilization under which the session will be considered idle +* **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