From fef62e546598fb8b3e0f30cf933d4ac0d28976a1 Mon Sep 17 00:00:00 2001 From: revital Date: Sun, 23 Mar 2025 08:25:30 +0200 Subject: [PATCH] Edits --- docs/clearml_agent/clearml_agent_setup.md | 2 +- docs/clearml_sdk/clearml_sdk_setup.md | 2 +- docs/clearml_sdk/task_sdk.md | 1 + docs/deploying_clearml/enterprise_deploy/app_custom.md | 4 ++-- .../enterprise_deploy/appgw_install_k8s.md | 2 +- docs/hyperdatasets/webapp/webapp_datasets_versioning.md | 2 +- docs/release_notes/clearml_server/enterprise/ver_3_24.md | 2 +- docs/webapp/webapp_overview.md | 6 ++++++ 8 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/clearml_agent/clearml_agent_setup.md b/docs/clearml_agent/clearml_agent_setup.md index 2e744de0..2126b322 100644 --- a/docs/clearml_agent/clearml_agent_setup.md +++ b/docs/clearml_agent/clearml_agent_setup.md @@ -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. ``` diff --git a/docs/clearml_sdk/clearml_sdk_setup.md b/docs/clearml_sdk/clearml_sdk_setup.md index ccb56523..7a7c53a7 100644 --- a/docs/clearml_sdk/clearml_sdk_setup.md +++ b/docs/clearml_sdk/clearml_sdk_setup.md @@ -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="*******" diff --git a/docs/clearml_sdk/task_sdk.md b/docs/clearml_sdk/task_sdk.md index f787eb6f..5f90e42c 100644 --- a/docs/clearml_sdk/task_sdk.md +++ b/docs/clearml_sdk/task_sdk.md @@ -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: diff --git a/docs/deploying_clearml/enterprise_deploy/app_custom.md b/docs/deploying_clearml/enterprise_deploy/app_custom.md index 5d6833fe..28a71960 100644 --- a/docs/deploying_clearml/enterprise_deploy/app_custom.md +++ b/docs/deploying_clearml/enterprise_deploy/app_custom.md @@ -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` diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index 3a7e546f..16d4efc0 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -68,7 +68,7 @@ tcpSession: end: ``` -Configuration options: +**Configuration options:** * `imageCredentials.password`: ClearML DockerHub Access Token. * `clearml.apiServerKey`: ClearML server API key. diff --git a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md index f40d44a3..c8cd0441 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md @@ -145,7 +145,7 @@ filters. * Source rule - Query frame source information. Enter a Lucene query of frame metadata fields in the format `sources.:` (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. diff --git a/docs/release_notes/clearml_server/enterprise/ver_3_24.md b/docs/release_notes/clearml_server/enterprise/ver_3_24.md index 0eaf5082..38c45470 100644 --- a/docs/release_notes/clearml_server/enterprise/ver_3_24.md +++ b/docs/release_notes/clearml_server/enterprise/ver_3_24.md @@ -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 diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 378bc62d..025774a8 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -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: * ClearML Apps[Applications](applications/apps_overview.md) - ClearML's GUI applications for no-code workflow execution (available in the ClearML Pro and Enterprise plans). + * Workers and Queues[Orchestration](webapp_workers_queues.md) - Autoscaling, resource usage monitoring and allocation management. + * Model endpoints[Model Endpoints](webapp_model_endpoints.md) - Monitor your live model endpoints. + * Datasets[Datasets](datasets/webapp_dataset_page.md) - View and manage your datasets. + * Projects[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) + * Pipelines[Pipelines](pipelines/webapp_pipeline_page.md) - View and manage your pipelines. ## UI Top Bar