mirror of
				https://github.com/clearml/clearml-docs
				synced 2025-06-26 18:17:44 +00:00 
			
		
		
		
	Edits
This commit is contained in:
		
							parent
							
								
									1f8687cea5
								
							
						
					
					
						commit
						fef62e5465
					
				@ -40,7 +40,7 @@ it can't do that when running from a virtual environment.
 | 
			
		||||
    If the setup wizard's response indicates that a configuration file already exists, follow the instructions [here](#adding-clearml-agent-to-a-configuration-file). 
 | 
			
		||||
   The wizard does not edit or overwrite existing configuration files.
 | 
			
		||||
 | 
			
		||||
1. At the command prompt `Paste copied configuration here:`, copy and paste the ClearML credentials and press **Enter**. 
 | 
			
		||||
1. At the command prompt `Paste copied configuration here:`, paste the ClearML credentials and press **Enter**. 
 | 
			
		||||
   The setup wizard confirms the credentials. 
 | 
			
		||||
        
 | 
			
		||||
   ```
 | 
			
		||||
 | 
			
		||||
@ -68,7 +68,7 @@ pip install clearml
 | 
			
		||||
   The **LOCAL PYTHON** tab shows the data required by the setup wizard (a copy to clipboard action is available on 
 | 
			
		||||
   hover).
 | 
			
		||||
    
 | 
			
		||||
1. At the command prompt `Paste copied configuration here:`, copy and paste the ClearML credentials.
 | 
			
		||||
1. At the command prompt `Paste copied configuration here:`, paste the ClearML credentials.
 | 
			
		||||
   The setup wizard verifies the credentials. 
 | 
			
		||||
   ```console
 | 
			
		||||
   Detected credentials key="********************" secret="*******"
 | 
			
		||||
 | 
			
		||||
@ -65,6 +65,7 @@ After invoking `Task.init` in a script, ClearML starts its automagical logging,
 | 
			
		||||
        * [argparse](../guides/reporting/hyper_parameters.md#argparse-command-line-options)
 | 
			
		||||
        * [Python Fire](../integrations/python_fire.md)
 | 
			
		||||
        * [LightningCLI](../integrations/pytorch_lightning.md)
 | 
			
		||||
        * [jsonargparse](../integrations/jsonargparse.md)
 | 
			
		||||
    * TensorFlow Definitions (`absl-py`)
 | 
			
		||||
    * [Hydra](../integrations/hydra.md) - ClearML logs the OmegaConf which holds all the configuration files, as well as values overridden during runtime. 
 | 
			
		||||
* **Models** - ClearML automatically logs and updates the models and all snapshot paths saved with the following frameworks:
 | 
			
		||||
 | 
			
		||||
@ -120,8 +120,8 @@ The `wizard` section defines the entries to display in the application instance
 | 
			
		||||
    * `model`
 | 
			
		||||
    * `queue`
 | 
			
		||||
    * `dataset_version`
 | 
			
		||||
  * `display_field` - The field of the source object to display in the list. Usually “name”
 | 
			
		||||
  * `value_field` - The field of the source object to use for configuring the app instance. Usually “id”
 | 
			
		||||
  * `display_field` - The field of the source object to display in the list. Usually "name"
 | 
			
		||||
  * `value_field` - The field of the source object to use for configuring the app instance. Usually "id"
 | 
			
		||||
  * `filter` - Allows to limit the choices list by setting a filter on one or more of the object’s fields. See Project Selection example below
 | 
			
		||||
* `target` - Where in the application instance’s task the values will be set. Contains the following:
 | 
			
		||||
  * `field` - Either `configuration` or `hyperparams`
 | 
			
		||||
 | 
			
		||||
@ -68,7 +68,7 @@ tcpSession:
 | 
			
		||||
    end:
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Configuration options:
 | 
			
		||||
**Configuration options:**
 | 
			
		||||
 | 
			
		||||
* `imageCredentials.password`: ClearML DockerHub Access Token.
 | 
			
		||||
* `clearml.apiServerKey`: ClearML server API key.  
 | 
			
		||||
 | 
			
		||||
@ -145,7 +145,7 @@ filters.
 | 
			
		||||
   * Source rule - Query frame source information. Enter a Lucene query of frame metadata fields in the format 
 | 
			
		||||
   `sources.<key>:<value>` (can use AND, OR, and NOT operators).
 | 
			
		||||
   
 | 
			
		||||
A frame filter can contain a number of rules. For each frame filter, the rules are applied with a logical AND operator. For example, the dataset version in the image below has one filter. “Frame Filter 1” has two rules: 
 | 
			
		||||
A frame filter can contain a number of rules. For each frame filter, the rules are applied with a logical AND operator. For example, the dataset version in the image below has one filter. "Frame Filter 1" has two rules: 
 | 
			
		||||
1. ROI rule - the frame must include an ROI with the `cat` label
 | 
			
		||||
2. Source rule - the frames must be 640 pixels wide. 
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -24,7 +24,7 @@ title: Version 3.24
 | 
			
		||||
* Add grouped same-event view to UI "Latest Task Events"
 | 
			
		||||
 | 
			
		||||
**Bug Fixes**
 | 
			
		||||
* Fix downloaded CSV file of UI “Latest Task Events” missing some events 
 | 
			
		||||
* Fix downloaded CSV file of UI "Latest Task Events" missing some events 
 | 
			
		||||
* Fix access permissions to UI Reports
 | 
			
		||||
* Fix configuration modal of UI application instance displays incorrect values
 | 
			
		||||
* Fix UI Hyper-Dataset frame viewer navigation controls not displaying 
 | 
			
		||||
 | 
			
		||||
@ -18,16 +18,22 @@ The **ClearML Web UI** is the graphical user interface for the ClearML platform,
 | 
			
		||||
The WebApp's sidebar provides access to the following modules:
 | 
			
		||||
 | 
			
		||||
* <img src="/docs/latest/icons/ico-applications.svg" alt="ClearML Apps" className="icon size-md space-md" />[Applications](applications/apps_overview.md) - ClearML's GUI applications for no-code workflow execution (available in the ClearML Pro and Enterprise plans).
 | 
			
		||||
 | 
			
		||||
* <img src="/docs/latest/icons/ico-workers.svg" alt="Workers and Queues" className="icon size-md space-md" />[Orchestration](webapp_workers_queues.md) - Autoscaling, resource usage monitoring and allocation management.
 | 
			
		||||
 | 
			
		||||
* <img src="/docs/latest/icons/ico-model-endpoints.svg" alt="Model endpoints" className="icon size-md space-md" />[Model Endpoints](webapp_model_endpoints.md) - Monitor your live model endpoints. 
 | 
			
		||||
 | 
			
		||||
* <img src="/docs/latest/icons/ico-side-bar-datasets.svg" alt="Datasets" className="icon size-md space-md" />[Datasets](datasets/webapp_dataset_page.md) - View and manage your datasets.
 | 
			
		||||
 | 
			
		||||
* <img src="/docs/latest/icons/ico-projects.svg" alt="Projects" className="icon size-md space-md" />[Projects](webapp_projects_page.md) - The main experimentation page. Access your tasks and models as they are organized into projects. The tasks and models are displayed in tables which let you:
 | 
			
		||||
 | 
			
		||||
  * Track ongoing tasks and visualize their results
 | 
			
		||||
  * Reproduce previous task runs 
 | 
			
		||||
  * Tune task parameter values with no code change
 | 
			
		||||
  * Compare tasks and models
 | 
			
		||||
  * Share tasks and models with other ClearML hosted service users
 | 
			
		||||
  * Create and share rich content [Reports](webapp_reports.md)
 | 
			
		||||
 | 
			
		||||
* <img src="/docs/latest/icons/ico-pipelines.svg" alt="Pipelines" className="icon size-md space-md" />[Pipelines](pipelines/webapp_pipeline_page.md) - View and manage your pipelines.
 | 
			
		||||
 | 
			
		||||
## UI Top Bar 
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user