From 43951da0bdc3f59f94c86892b37e531832832bf2 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 13 Nov 2024 14:03:53 +0200 Subject: [PATCH] Small edits (#962) --- .../webapp/applications/apps_aws_autoscaler.md | 2 +- .../webapp/applications/apps_gcp_autoscaler.md | 2 +- docs/webapp/applications/apps_gradio.md | 2 +- docs/webapp/applications/apps_streamlit.md | 2 +- docs/webapp/webapp_exp_track_visual.md | 18 +++++++++--------- docs/webapp/webapp_model_endpoints.md | 2 +- docs/webapp/webapp_model_table.md | 2 +- docs/webapp/webapp_model_viewing.md | 8 ++++---- docs/webapp/webapp_orchestration_dash.md | 2 +- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md index 1ca038c0..43fbaccb 100644 --- a/docs/webapp/applications/apps_aws_autoscaler.md +++ b/docs/webapp/applications/apps_aws_autoscaler.md @@ -225,7 +225,7 @@ The console's log level will update in the autoscaler's next iteration. ::: * Instance log files - Click to access the app instance's logs. This takes you to the app instance task's ARTIFACTS tab, - which lists the app instance's logs. In a log's `File Path` field, click Download + which lists the app instance's logs. In a log's `File Path` field, click Download to download the complete log. diff --git a/docs/webapp/applications/apps_gcp_autoscaler.md b/docs/webapp/applications/apps_gcp_autoscaler.md index 340f028a..b3009e84 100644 --- a/docs/webapp/applications/apps_gcp_autoscaler.md +++ b/docs/webapp/applications/apps_gcp_autoscaler.md @@ -149,7 +149,7 @@ The console's log level will update in the autoscaler's next iteration. ::: * Instance log files - Click to access the app instance's logs. This takes you to the app instance task's ARTIFACTS tab, - which lists the app instance's logs. In a log's `File Path` field, click Download + which lists the app instance's logs. In a log's `File Path` field, click Download to download the complete log. :::tip EMBEDDING CLEARML VISUALIZATION diff --git a/docs/webapp/applications/apps_gradio.md b/docs/webapp/applications/apps_gradio.md index 69a1ba3c..dbb7c4ee 100644 --- a/docs/webapp/applications/apps_gradio.md +++ b/docs/webapp/applications/apps_gradio.md @@ -29,7 +29,7 @@ Once you start a Gradio launcher instance, you can view the following informatio * Stopped server - App is stopped * Idle time * Gradio App - Externally accessible link to your Gradio app. You can send this link to your colleagues, so they can - access the app. Click Copy + access the app. Click Copy to copy link * Gradio Git repo - Repository that holds the Gradio app script * Live preview of the Gradio app diff --git a/docs/webapp/applications/apps_streamlit.md b/docs/webapp/applications/apps_streamlit.md index ff54cb6e..06017019 100644 --- a/docs/webapp/applications/apps_streamlit.md +++ b/docs/webapp/applications/apps_streamlit.md @@ -30,7 +30,7 @@ Once you start a Streamlit launcher instance, you can view the following informa * Stopped server - App is stopped * Idle time * Streamlit App - Externally accessible link to your Streamlit app. You can send this link to your colleagues, so they can - access the app. Click Copy + access the app. Click Copy to copy link * Streamlit Git repo - Repository that holds the Streamlit app script * Live preview of the Streamlit app diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index afdf35f3..227f3d00 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -23,7 +23,7 @@ The ClearML Web UI provides two viewing modes for experiment details: * Full screen details mode. Both modes contain all experiment details. When either view is open, switch to the other mode by clicking Table/Full screen view -(**View in experiments table / full screen**), or clicking Bars menu (**menu**) > **View in experiments +(**View in experiments table / full screen**), or clicking Bars menu (**menu**) > **View in experiments table / full screen**. @@ -179,10 +179,10 @@ parameter in [`Task.connect_configuration`](../references/sdk/task.md#connect_co Artifacts tracked in an experiment appear in the **ARTIFACTS** tab, and include models and other artifacts. -Artifacts location is stored in the `FILE PATH` field. -The UI provides locally stored artifacts with a 'copy to clipboard' action (Clipboard) +Artifact location is displayed in the `FILE PATH` field. +The UI provides locally stored artifacts with a 'copy to clipboard' action (Clipboard) to facilitate local storage access (since web applications are prohibited from accessing the local disk for security reasons). -The UI provides Network hosted (e.g. https://, s3:// etc. URIs) artifacts with a download action (Download) +The UI provides Network hosted (e.g. https://, s3:// etc. URIs) artifacts with a download action (Download) to retrieve these files. ### Models @@ -298,7 +298,7 @@ Scalar series can be displayed in [graph view](#graph-view) (default) or in [met #### Graph View Scalar graph view (Graph view) shows scalar series plotted as a time series line chart. The series are sub-sampled for -display efficiency. For high resolution, view a series in full screen mode by hovering over the graph and clicking Maximize plot icon. +display efficiency. For high resolution, view a series in full screen mode by hovering over the graph and clicking Maximize plot icon. :::info Full Screen Refresh Scalar graphs in full screen mode do not auto-refresh. Click Refresh @@ -377,9 +377,9 @@ Plotly plots. Individual plots can be shown / hidden or filtered by title. For each metric, the latest reported plot is displayed. -When viewing a plot in full screen (Maximize plot icon), +When viewing a plot in full screen (Maximize plot icon), older iterations are available through the iteration slider (or using the up/down arrow keyboard shortcut). Go to the -previous/next plot in the current iteration using the Previous / Next +previous/next plot in the current iteration using the Previous / Next buttons (or using the left/right arrow keyboard shortcut). @@ -437,7 +437,7 @@ For each metric, the latest reported debug sample is displayed. Click a sample to view it in full screen. If the sample is video or audio, the full screen mode includes a player. When viewing a sample in full screen, older iterations are available through the iteration slider (or using the up/down -arrow keyboard shortcut). Go to the previous/next sample in the current iteration using the Previous / Next +arrow keyboard shortcut). Go to the previous/next sample in the current iteration using the Previous / Next buttons (or using the left/right arrow keyboard shortcut). @@ -468,7 +468,7 @@ experiment execution according to their tags (see [TriggerScheduler](../referenc deploy models according to their tags (see [ClearML Serving](../clearml_serving/clearml_serving_tutorial.md#automatic-model-deployment)). **To add tags:** -1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or Bars menu (menu) +1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or Bars menu (menu) 1. Do one of the following: * Add a new tag - Type the new tag name **>** **(Create New)**. * Add an existing tag - Click a tag. diff --git a/docs/webapp/webapp_model_endpoints.md b/docs/webapp/webapp_model_endpoints.md index 737edd9f..d5ce3361 100644 --- a/docs/webapp/webapp_model_endpoints.md +++ b/docs/webapp/webapp_model_endpoints.md @@ -16,7 +16,7 @@ using the buttons on the top left of the page. Use the table view for a comparat columns of interest. Use the details view to access a selected endpoint's details. Details view can also be accessed by double-clicking a specific endpoint in the table view to open its details view. -Download the model endpoint table as a CSV file by clicking **Download** Download. +Download the model endpoint table as a CSV file by clicking **Download** Download. ## Endpoint Tables diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md index 9b9ce899..8d93ea57 100644 --- a/docs/webapp/webapp_model_table.md +++ b/docs/webapp/webapp_model_table.md @@ -117,7 +117,7 @@ group of experiments. A tag can show any text, for any purpose. For example, add experiments execute on, label versions of experiments, or apply team names to organize experimentation. * To Add tags and to change tag colors: - 1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or Bars menu + 1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or Bars menu (menu) 1. Do one of the following: * Add a new tag - Type the new tag name **>** **(Create New)**. diff --git a/docs/webapp/webapp_model_viewing.md b/docs/webapp/webapp_model_viewing.md index 225d1cfa..53b66a67 100644 --- a/docs/webapp/webapp_model_viewing.md +++ b/docs/webapp/webapp_model_viewing.md @@ -37,9 +37,9 @@ Hover over the model configuration area to access the following actions: ![Model config actions](../img/webapp_model_config_actions.png) -* Magnifying glass Search -* Copy Copy configuration -* TrashCLEAR (for Draft models) - Delete the configuration +* Magnifying glass Search +* Copy Copy configuration +* TrashCLEAR (for Draft models) - Delete the configuration * EDIT (for Draft models) - Modify / Add model configuration ## Label Enumeration @@ -81,7 +81,7 @@ Use the search bar to look for experiments based on their name, ID, or descripti The **SCALARS** tab displays all scalar plots attached to a model. Scalar values are presented as time series line plots. To see the series for a metric in high resolution, view it in full screen mode by hovering over the graph and -clicking Maximize plot icon. +clicking Maximize plot icon. Reported single value scalars are aggregated into a table plot displaying scalar names and values. To embed scalar plots in your [Reports](webapp_reports.md), hover over a plot and click Embed code, diff --git a/docs/webapp/webapp_orchestration_dash.md b/docs/webapp/webapp_orchestration_dash.md index a1033e0d..1b705db6 100644 --- a/docs/webapp/webapp_orchestration_dash.md +++ b/docs/webapp/webapp_orchestration_dash.md @@ -45,7 +45,7 @@ Hover over any of this data to see the number of currently idle machines. Use the **Event Log** to view updates of worker events: worker addition/removal, worker has become idle/busy. Hover over the log to download (Download) -it or open the expanded view (Maximize). +it or open the expanded view (Maximize). ## Resource Graph