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

Small edits (#534)

Browse Source
This commit is contained in:
pollfly
2023-04-16 12:32:48 +03:00
committed by GitHub
parent 48e0a1d453
commit 1a098e9b09
34 changed files with 46 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -31,11 +31,11 @@ each instance is spun up.
repositories to retrieve the code for their jobs
* Git User
* Git Password / Personal Access Token
* **Max Idle Time** (Optional) - Maximum time in minutes that an EC2 instance can be idle before the autoscaler spins it
* **Max Idle Time** (optional) - Maximum time in minutes that an EC2 instance can be idle before the autoscaler spins it
down
* **Workers Prefix** (Optional) - A Prefix added to workers’ names, associating them with this autoscaler
* **Polling Interval** (Optional) - Time period in minutes at which the designated queue is polled for new tasks
* **Base Docker Image** (Optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored
* **Workers Prefix** (optional) - A Prefix added to workers’ names, associating them with this autoscaler
* **Polling Interval** (optional) - Time period in minutes at which the designated queue is polled for new tasks
* **Base Docker Image** (optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored
in a Docker artifactory so instances can automatically fetch it
* **Compute Resources**
* Resource Name - Assign a name to the resource type. This name will appear in the Autoscaler dashboard
@@ -49,24 +49,24 @@ each instance is spun up.
* Max Number of Instances - Maximum number of concurrent running instances of this type allowed
* Monitored Queue - Queue associated with this instance type. The tasks enqueued to this queue will be executed on
instances of this type
* EC2 Tags (Optional) - AWS instance tags to attach to launched EC2 instances. Insert key=value pairs, separated by
* EC2 Tags (optional) - AWS instance tags to attach to launched EC2 instances. Insert key=value pairs, separated by
commas
* EBS Device (Optional) - Disk mount point
* EBS Volume Size (Optional) - Disk size (GB)
* EBS Volume Type (Optional) - See [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)
* EBS Device (optional) - Disk mount point
* EBS Volume Size (optional) - Disk size (GB)
* EBS Volume Type (optional) - See [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)
for full list of types
* Instance Key Pair (Optional) - AWS key pair that is provided to the spun EC2 instances for connecting to them via
* Instance Key Pair (optional) - AWS key pair that is provided to the spun EC2 instances for connecting to them via
SSH. Provide the Key Pair's name, as was created in AWS. See [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html)
for more details
* Security Group ID (Optional) - Comma separated list of AWS VPC Security Group IDs to attach to the launched
* Security Group ID (optional) - Comma separated list of AWS VPC Security Group IDs to attach to the launched
instance. Read more [here](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html)
* \+ Add Item - Define another resource type
* **IAM Instance Profile** (Optional) - Set an IAM instance profile for all instances spun by the Autoscaler
* **IAM Instance Profile** (optional) - Set an IAM instance profile for all instances spun by the Autoscaler
* Arn - Amazon Resource Name specifying the instance profile
* Name - Name identifying the instance profile
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Init script** (Optional) - A bash script to execute after launching the EC2 instance
* **Additional ClearML Configuration** (Optional) - A ClearML configuration file to use by the ClearML Agent when
* **Autoscaler Instance Name** (optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Init script** (optional) - A bash script to execute after launching the EC2 instance
* **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when
executing your experiments
* **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

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

@@ -19,7 +19,7 @@ on failed Tasks via Slack integration.
* Monitored Metric - Series - Metric series (variant) to track
* Monitored Metric - Trend - Choose whether to track the monitored metric's highest or lowest values
* **Dashboard Title** - Name of the project dashboard instance, which will appear in the instance list
* **Failed Task Slack Monitor** (Optional)
* **Failed Task Slack Monitor** (optional)
* API Token - Slack workspace access token
* Channel Name - Slack channel to which task failure alerts will be posted
* Fail Iteration Threshold - Minimum number of iterations to trigger Slack alerts about task failure (failed tasks that do not meet the threshold will be ignored)

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

@@ -30,7 +30,7 @@ when each VM instance is spun up.
repositories to retrieve the code for their jobs
* Git User
* Git Password / Personal Access Token
* **Base Docker Image** (Optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored in a
* **Base Docker Image** (optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored in a
Docker artifactory so VM instances can automatically fetch it
* **Compute Resources**
* Resource Name - Assign a name to the resource type. This name will appear in the Autoscaler dashboard
@@ -40,15 +40,15 @@ when each VM instance is spun up.
* Use Preemptible Instance - Choose whether VM instances of this type will be [preemptible](https://cloud.google.com/compute/docs/instances/preemptible)
* Max Number of Instances - Maximum number of concurrent running VM instances of this type allowed
* Monitored Queue - Queue associated with this VM instance type. The tasks enqueued to this queue will be executed on VM instances of this type
* Machine Image (Optional) - The GCP machine image to launch
* Disc Size (in GB) (Optional)
* Machine Image (optional) - The GCP machine image to launch
* Disc Size (in GB) (optional)
* \+ Add Item - Define another resource type
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Max Idle Time** (Optional) - Maximum time in minutes that a VM instance can be idle before the autoscaler spins it down
* **Workers Prefix** (Optional) - A Prefix added to workers’ names, associating them with this autoscaler
* **Polling Interval** (Optional) - Time period in minutes at which the designated queue is polled for new tasks
* **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
* **Autoscaler Instance Name** (optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Max Idle Time** (optional) - Maximum time in minutes that a VM instance can be idle before the autoscaler spins it down
* **Workers Prefix** (optional) - A Prefix added to workers’ names, associating them with this autoscaler
* **Polling Interval** (optional) - Time period in minutes at which the designated queue is polled for new tasks
* **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
* **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.

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

@@ -27,13 +27,13 @@ queue. The app instance automatically terminates idle machines based on a specif
* Monitored Queue - Queue associated with application instance. The tasks enqueued to this queue will be executed on
machines of this specification
* Cloud Machine Limit - Maximum number of concurrent machines to launch
* **Idle Time Limit** (Optional) - Maximum time in minutes that a cloud machine can be idle before it is spun down
* **Default Docker Image** (Optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored
* **Idle Time Limit** (optional) - Maximum time in minutes that a cloud machine can be idle before it is spun down
* **Default Docker Image** (optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored
in a Docker artifactory so instances can automatically fetch it
* **Git Configuration** - Git credentials with which the ClearML Agents running on your cloud instances will access your repositories to retrieve the code for their jobs
* Git User
* Git Password / Personal Access Token
* **Cloud Storage Access** (Optional) - Access credentials to cloud storage service. Provides ClearML Tasks running on cloud
* **Cloud Storage Access** (optional) - Access credentials to cloud storage service. Provides ClearML Tasks running on cloud
machines access to your storage
![GPU Compute wizard](../../img/apps_gpu_compute_wizard.png)

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

@@ -54,11 +54,11 @@ limits.
Additionally, make sure that the initial experiment's `_allow_omegaconf_edit_` parameter is set to `False` (in experiment's
**CONFIGURATION > HYPERPARAMETERS > Hydra**).
:::
* **Optimization Job Title** (Optional) - Name for the HPO instance. This will appear in the instance list
* **Optimization Experiments Destination Project** (Optional) - The project where optimization tasks will be saved.
* **Optimization Job Title** (optional) - Name for the HPO instance. This will appear in the instance list
* **Optimization Experiments Destination Project** (optional) - The project where optimization tasks will be saved.
Leave empty to use the same project as the Initial task.
* **Maximum Concurrent Tasks** - The maximum number of simultaneously running optimization experiments
* **Advanced Configuration** (Optional)
* **Advanced Configuration** (optional)
* Limit Total HPO Experiments - Maximum total number of optimization experiments
* Number of Top Experiments to Save - Number of best performing experiments to save (the rest are archived)
* Limit Single Experiment Running Time (Minutes) - Time limit per optimization experiment. Experiments will be

10
docs/webapp/webapp_exp_comparing.md
View File

@@ -45,7 +45,7 @@ The **DETAILS** tab includes deep comparisons of the following:
**To Locate the Source Differences:**
Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Up arrow" className="icon size-md" />
(Previous diff) or <img src="/docs/latest/icons/ico-next-diff.svg" alt="Down arrow" className="icon size-md space-sm" /> (Next diff).
(previous diff) or <img src="/docs/latest/icons/ico-next-diff.svg" alt="Down arrow" className="icon size-md space-sm" /> (next diff).
For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model names
are different.
@@ -68,8 +68,8 @@ The Values mode is a side-by-side comparison that shows hyperparameter value dif
1. In the dropdown menu (on the upper left, next to **+ Add Experiments**), choose **Values**.
1. To show only differences, move the **Hide Identical Fields** slider to on.
1. Locate differences by either:
* Clicking <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Up arrow" className="icon size-md space-sm" /> (Previous diff) or
<img src="/docs/latest/icons/ico-next-diff.svg" alt="Down arrow" className="icon size-md space-sm" /> (Next diff).
* Clicking <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Up arrow" className="icon size-md space-sm" /> (previous diff) or
<img src="/docs/latest/icons/ico-next-diff.svg" alt="Down arrow" className="icon size-md space-sm" /> (next diff).
* Scrolling to see highlighted hyperparameters.
For example, expanding **General** shows that the `batch_size` and `epochs` differ between the experiments.
@@ -190,8 +190,8 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
1. Locate debug samples by doing the following:
* Filter by metric. In the **Metric** list, choose a metric.
* Show other iterations. Click <img src="/docs/latest/icons/ico-circle-older.svg" alt="Left arrow" className="icon size-md space-sm" /> (Older images),
<img src="/docs/latest/icons/ico-circle-newer.svg" alt="Right arrow" className="icon size-md space-sm" /> (New images), or <img src="/docs/latest/icons/ico-circle-newest.svg" alt="right arrow, newest image" className="icon size-md space-sm" /> (Newest images).
* Show other iterations. Click <img src="/docs/latest/icons/ico-circle-older.svg" alt="Left arrow" className="icon size-md space-sm" /> (older images),
<img src="/docs/latest/icons/ico-circle-newer.svg" alt="Right arrow" className="icon size-md space-sm" /> (new images), or <img src="/docs/latest/icons/ico-circle-newest.svg" alt="right arrow, newest image" className="icon size-md space-sm" /> (newest images).
* Click <img src="/docs/latest/icons/ico-disconnect.svg" alt="Sync selection" className="icon size-md space-sm" /> in
order to synchronize iteration and metric selection across experiments. For example, if you select a metric for
one experiment’s debug samples, the same metric will be automatically selected for the rest of the experiments in the comparison.