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

Update docs (#330)

Browse Source
This commit is contained in:
pollfly
2022-09-15 16:10:11 +03:00
committed by GitHub
parent c8f96230bf
commit 5a65a2654b
43 changed files with 182 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -18,9 +18,11 @@ queue (until reaching the defined maximum number of instances). You can add an i
each instance is spun up.
## 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)
* 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
* AWS Region - [AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions)
where the EC2 instances will be spun up
* AWS Access Key ID and AWS Secret Access Key - The credentials with which the autoscaler will access your AWS
@@ -53,17 +55,19 @@ each instance is spun up.
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
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.
for more details
* 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
* 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.
* **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
![Autoscaler wizard](../../img/app_aws_autoscaler_wizard.png)

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

@@ -19,11 +19,13 @@ in a queue (until reaching the defined maximum number of instances). You can add
when each VM instance is spun up.
## 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 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 Credentials - Project credentials, see [here](https://cloud.google.com/docs/authentication/production) for
more details.
more details
* **Git Configuration** - Git credentials with which the ClearML Agents running on your VM instances will access your
repositories to retrieve the code for their jobs
* Git User
@@ -31,23 +33,25 @@ when each VM instance is spun up.
* **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.
* Resource Name - Assign a name to the resource type. This name will appear in the Autoscaler dashboard
* GCP Machine Type - See list of [machine types](https://cloud.google.com/compute/docs/machine-types)
* Run in CPU mode - Select to have the autoscaler utilize only CPU VM instances
* GPU Type - See list of [supported GPUs by instance](https://cloud.google.com/compute/docs/gpus)
* Use Preemptible Instance - Choose whether VM instances of this type will be [preemptible](https://cloud.google.com/compute/docs/instances/preemptible).
* 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)
* \+ Add Item - Define another resource type
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list.
* **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.
![GCP autoscaler wizard](../../img/apps_gcp_autoscaler_wizard.png)
:::note Enterprise Feature

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

@@ -19,8 +19,10 @@ 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
values from the file, which can be modified before launching the app instance
* **Initial Task to Optimize** - ID of an existing 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 Configuration**
* Optimization Method - The optimization strategy to employ (e.g. random, grid, hyperband)
* Optimization Objective Metric’s Title - Title of metric to optimize
@@ -38,15 +40,15 @@ limits.
* Discrete Parameters - A set of values to sample
* Values - Comma separated list of values to sample
* Name - The original task’s configuration parameter name (including section name e.g. `Args/lr`)
* **Optimization Job Title** (Optional) - Name for the HPO instance. This will appear in the instance list.
* **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)
* 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).
* 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
stopped after the specified time elapsed.
stopped after the specified time elapsed
* Minimal Number of Iterations Per Single Experiment - Some search methods, such as Optuna, prune underperforming
experiments. This is the minimum number of iterations per experiment before it can be stopped. Iterations are
based on the experiments' own reporting (for example, if experiments report every epoch, then iterations=epochs)
@@ -54,7 +56,9 @@ limits.
stopped. Iterations are based on the experiments' own reporting (for example, if experiments report every epoch,
then iterations=epochs)
* 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)
## Dashboard

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

@@ -34,6 +34,16 @@ Each application’s page is split into two sections:
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
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.
:::
## App Instance Actions
Access app instance actions, by right clicking an instance, or through the menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> (available on hover).
@@ -41,6 +51,22 @@ Access app instance actions, by right clicking an instance, or through the menu
* **Rename** - Rename the instance
* **Configuration** - View an instance’s configuration
* **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
* **Stop** - Shutdown the instance
* **Clone** - Launch a new instance with same configuration prefilled
* **Delete** - Delete the instance
## Instance List Actions
Access the instance list actions by clicking the action menu ( <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> )
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
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
deletes instances in the current instance list view (i.e. My instances / All).

4
docs/webapp/datasets/webapp_dataset_viewing.md
View File

@@ -40,7 +40,9 @@ On the right side of the dataset version panel, view the **VERSION INFO** which
* Number of files modified
* Number of files removed
* Change in size
* Version description - to modify, hover over description and click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" /> ,
which opens the edit window
<div class="max-w-50">
![Version info](../../img/webapp_dataset_version_info.png)

3
docs/webapp/pipelines/webapp_pipeline_table.md
View File

@@ -10,6 +10,7 @@ View the runs table in table view <img src="/docs/latest/icons/ico-table-view.sv
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your runs according to
columns of interest. Use the details view to access a selected run’s details, while keeping the pipeline runs list in view.
Details view can also be accessed by double clicking a specific pipeline run in the table view to open its details view.
![Pipeline runs table](../../img/webapp_pipeline_runs_table.png)
@@ -99,7 +100,7 @@ Access these actions with the context menu in any of the following ways:
| Action | Description | States Valid for the Action | State Transition |
|---|---|---|---|
| Details | View pipeline details. | Any state | None |
| Details | View pipeline details. Can also be accessed by double clicking a run in the pipeline runs table. | Any state | None |
| Run | Create a new pipeline run. Configure and enqueue it for execution. See [Create Run](#create-run). | Any State | *Pending* |
| Abort | Manually stop / cancel a run. | *Running* / *Pending* | *Aborted* |
| Continue | Rerun with the same parameters. | *Aborted* | *Pending* |

3
docs/webapp/webapp_exp_comparing.md
View File

@@ -192,6 +192,9 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
* 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).
* 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.
![image](../img/webapp_compare_30.png)

4
docs/webapp/webapp_exp_table.md
View File

@@ -10,7 +10,7 @@ View the experiments table in table view <img src="/docs/latest/icons/ico-table-
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your experiments according
to columns of interest. Use the details view to access a selected experiment’s details, while keeping the experiment list
in view.
in view. Details view can also be accessed by double clicking a specific experiment in the table view to open its details view.
:::info
To assist in focusing on active experimentation, experiments and models can be archived, so they will not appear
@@ -137,7 +137,7 @@ Access these actions with the context menu in any of the following ways:
| Action | Description | States Valid for the Action | State Transition |
|---|---|---|---|
| Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). | Any state | None |
| Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). Can also be accessed by double clicking an experiment in the experiments table. | Any state | None |
| View Full Screen | View experiment details in [full screen](webapp_exp_track_visual.md#full-screen-details-view). | Any state | None |
| Manage Queue | If an experiment is *Pending* in a queue, view the utilization of that queue, manage that queue (remove experiments and change the order of experiments), and view information about the worker(s) listening to the queue. See the [Workers and Queues](webapp_workers_queues.md) page. | *Enqueued* | None |
| View Worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None |

4
docs/webapp/webapp_model_table.md
View File

@@ -9,7 +9,7 @@ View the models table in table view <img src="/docs/latest/icons/ico-table-view.
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your models according to
columns of interest. Use the details view to access a selected model’s details, while keeping the model list in view.
Details view can also be accessed by double clicking a specific model in the table view to open its details view.
![Models table](../img/webapp_models_01.png)
@@ -73,7 +73,7 @@ Access these actions with the context menu in any of the following ways:
| ClearML Action | Description | States Valid for the Action |
|---|---|--|
| Details | Model details include general information, the model configuration, and label enumeration. | Any state |
| Details | View model details, which include general information, the model configuration, and label enumeration. Can also be accessed by double clicking a model in the models table | Any state |
| Publish | Publish a model to prevent changes to it. *Published* models are read-only. If a model is Published, its experiment also becomes Published (read-only). | *Draft* |
| Archive | To more easily work with active models, move a model to the archive. See [Archiving](webapp_archiving.md). | Any state |
| Restore | Action available in the archive. Restore a model to the active model table. | Any state |

2
docs/webapp/webapp_model_viewing.md
View File

@@ -2,7 +2,7 @@
title: Model Details
---
In the models table, click on a model to view and / or modify the following:
In the models table, double click on a model to view and / or modify the following:
* General model information
* Model configuration
* Model label enumeration

2
docs/webapp/webapp_profile.md
View File

@@ -70,7 +70,7 @@ to switch to.
### ClearML Credentials
Generate ClearML credentials, made up of an access and secret key pair, and insert them into your [configuration file](../configs/clearml_conf.md)
to grant the ClearML SDK and the ClearML Agent API access to the server.
or Jupyter Notebook to grant the ClearML SDK and the ClearML Agent API access to the server.
You can create credentials for any workspace that you are a member of.