ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-03 18:53:37 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Small edits (#852)

Browse Source
This commit is contained in:
pollfly 2024-06-10 10:40:43 +03:00 committed by GitHub
parent d4c5f6fa24
commit 9cbbbd4c43
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,7 +20,8 @@ each 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
* **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) * **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
role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). In such a case, no AWS IAM credentials are required role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). In such a case, no AWS IAM credentials are required
@ -89,7 +90,8 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
creating the instances launch spec. See [boto3 EC2.client.run_instances Request Syntax](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/run_instances.html) creating the instances launch spec. See [boto3 EC2.client.run_instances Request Syntax](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/run_instances.html)
and [AWS API Reference: RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) (available under ClearML Enterprise Plan) and [AWS API Reference: RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) (available under ClearML Enterprise Plan)
* **Run with Service Account** - Select to allow running the application under a [Service Account](../webapp_profile.md#service-accounts) identity instead of under your own identity (available under ClearML Enterprise Plan) * **Run with Service Account** - Select to allow running the application under a [Service Account](../webapp_profile.md#service-accounts) identity instead of under your own identity (available under ClearML Enterprise Plan)
* **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 wizard](../../img/app_aws_autoscaler_wizard.png)

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

@ -21,7 +21,8 @@ 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
* **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** * **GCP Configuration**
* GCP Project ID - Project used for spinning up VM instances * GCP Project ID - Project used for spinning up VM instances
* GCP Zone - The GCP zone where the VM instances will be spun up. See [Regions and zones](https://cloud.google.com/compute/docs/regions-zones) * GCP Zone - The GCP zone where the VM instances will be spun up. See [Regions and zones](https://cloud.google.com/compute/docs/regions-zones)
@ -81,6 +82,8 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* **Init Script** (optional) - A bash script to execute after launching the VM instance * **Init Script** (optional) - A bash script to execute after launching the VM instance
* **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments * **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments
* **Run with Service Account** - Select to allow running the application under a [Service Account](../webapp_profile.md#service-accounts) identity instead of under your own identity (available under ClearML Enterprise Plan) * **Run with Service Account** - Select to allow running the application under a [Service Account](../webapp_profile.md#service-accounts) identity instead of under your own identity (available under ClearML Enterprise Plan)
* **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 wizard](../../img/apps_gcp_autoscaler_wizard.png)

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

@ -19,6 +19,8 @@ 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
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
* **Optimization Method** - The optimization strategy to employ (e.g. random, grid, hyperband) * **Optimization Method** - The optimization strategy to employ (e.g. random, grid, hyperband)
@ -69,7 +71,8 @@ limits.
stopped. Iterations are based on the experiments' own reporting (for example, if experiments report every epoch, stopped. Iterations are based on the experiments' own reporting (for example, if experiments report every epoch,
then iterations=epochs) then iterations=epochs)
* Limit Total Optimization Instance Time (Minutes) - Time limit for the whole optimization process (in minutes) * Limit Total Optimization Instance Time (Minutes) - Time limit for the whole optimization process (in minutes)
* **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 wizard](../../img/apps_hpo_wizard.png)