diff --git a/docs/faq.md b/docs/faq.md index 097a25ea..c7ae5155 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -274,7 +274,7 @@ To fix this, the registered URL of each model needs to be replaced with its curr sudo docker exec -it clearml-mongo /bin/bash ``` -1. Create the following script inside the Docker shell (Make sure to replace `` and ``, as well as the URL protocol prefixes if you aren't using S3): +1. Create the following script inside the Docker shell (make sure to replace `` and ``, as well as the URL protocol prefixes if you aren't using S3): ```bash cat <> script.js db.model.find({uri:{$regex:/^s3/}}).forEach(function(e,i) { diff --git a/docs/guides/reporting/artifacts.md b/docs/guides/reporting/artifacts.md index 65d7e34a..5116d4e4 100644 --- a/docs/guides/reporting/artifacts.md +++ b/docs/guides/reporting/artifacts.md @@ -25,7 +25,7 @@ is different). Configure ClearML in any of the following ways: When the script runs, it creates a task named `artifacts example` in the `examples` project. ClearML reports artifacts in the **ClearML Web UI** **>** task details **>** **ARTIFACTS** tab. -examples_reporting_03 + ![Task artifacts](../../img/examples_reporting_03.png#light-mode-only) ![Task artifacts](../../img/examples_reporting_03_dark.png#dark-mode-only) diff --git a/docs/img/clearml_agent_flow_diagram.png b/docs/img/clearml_agent_flow_diagram.png index 7e7f2f68..1eb29eaa 100644 Binary files a/docs/img/clearml_agent_flow_diagram.png and b/docs/img/clearml_agent_flow_diagram.png differ diff --git a/docs/img/clearml_agent_flow_diagram_dark.png b/docs/img/clearml_agent_flow_diagram_dark.png index e2ef841b..8ebf0248 100644 Binary files a/docs/img/clearml_agent_flow_diagram_dark.png and b/docs/img/clearml_agent_flow_diagram_dark.png differ diff --git a/docs/img/colab_explicit_reporting_09_dark.png b/docs/img/colab_explicit_reporting_09_dark.png index 61dc626d..447919a1 100644 Binary files a/docs/img/colab_explicit_reporting_09_dark.png and b/docs/img/colab_explicit_reporting_09_dark.png differ diff --git a/docs/img/examples_using_artifacts_1_dark.png b/docs/img/examples_using_artifacts_1_dark.png index 43213108..4e706d10 100644 Binary files a/docs/img/examples_using_artifacts_1_dark.png and b/docs/img/examples_using_artifacts_1_dark.png differ diff --git a/docs/release_notes/clearml_agent/ver_1_4.md b/docs/release_notes/clearml_agent/ver_1_4.md index 66444063..45cdb67f 100644 --- a/docs/release_notes/clearml_agent/ver_1_4.md +++ b/docs/release_notes/clearml_agent/ver_1_4.md @@ -18,7 +18,7 @@ title: Version 1.4 * Add support for MIG devices (use `0:1` for GPU 0 slice 1, or use 0.1) * Add `agent.enable_git_ask_pass` to improve passing user/pass to git commands * Add docker `ssh_ro_folder` (default `/.ssh`) and changed docker `ssh_folder `(default: `~/.ssh`) -* Allow overriding pytorch lookup page (See `torch_page`, `torch_nightly_page` and `torch_url_template_prefix` under the +* Allow overriding pytorch lookup page (see `torch_page`, `torch_nightly_page` and `torch_url_template_prefix` under the `agent.package_manager` configuration settings) * Add support for abort callback registration * K8s glue diff --git a/docs/webapp/applications/apps_gradio.md b/docs/webapp/applications/apps_gradio.md index e8bb9a54..f9865bfe 100644 --- a/docs/webapp/applications/apps_gradio.md +++ b/docs/webapp/applications/apps_gradio.md @@ -70,7 +70,7 @@ to open the app's instance launch form. app instance task will be enqueued (make sure an agent is assigned to that queue) * **Docker Image** - Docker image the ClearML Agent will use for running the Gradio app * **Arguments** - Arguments to be passed to the script -* **Idle Time Limit** (Hours) - Maximum idle time (Period in which no requests are received by the Gradio app) after +* **Idle Time Limit** (Hours) - Maximum idle time (period in which no requests are received by the Gradio app) after which the Gradio app and the launcher instance will shut down. * **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 \ No newline at end of file diff --git a/docs/webapp/applications/apps_streamlit.md b/docs/webapp/applications/apps_streamlit.md index e7cba3ca..41ec88df 100644 --- a/docs/webapp/applications/apps_streamlit.md +++ b/docs/webapp/applications/apps_streamlit.md @@ -72,7 +72,7 @@ to open the app's instance launch form. app instance task will be enqueued (make sure an agent is assigned to that queue) * **Docker Image** - Docker image the ClearML Agent will use for running the Streamlit app * **Arguments** - Arguments to be passed to the script -* **Idle Time Limit** (Hours) - Maximum idle time (Period in which no requests are received by the Streamlit app) after +* **Idle Time Limit** (Hours) - Maximum idle time (period in which no requests are received by the Streamlit app) after which the Streamlit app and the launcher instance will shut down. * **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 diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 7284db68..36278e86 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -355,7 +355,7 @@ are on the left side of the window. The tools include: on each plot you want to view. :::tip Default scalar display -After adjusting the scalar display (e.g. grouping, axis, smoothing), click Set as default to save the current +After adjusting the scalar display (e.g. grouping, axis, smoothing), click **Set as default** to save the current configuration as the default view for the project’s task and model scalars. ::: diff --git a/docs/webapp/webapp_model_endpoints.md b/docs/webapp/webapp_model_endpoints.md index 394affe1..7003a3db 100644 --- a/docs/webapp/webapp_model_endpoints.md +++ b/docs/webapp/webapp_model_endpoints.md @@ -44,7 +44,7 @@ information: You can apply column filters by clicking Filter, and sort endpoints by clicking Sort order on the relevant column. -Use the page’s search bar to search by endpoint name, ID, and model fields. +Use the page's search bar Magnifying glass to search by endpoint name, ID, and model fields. ## Active Endpoint Details Clicking on a model endpoint opens it in detailed view. diff --git a/docs/webapp/webapp_projects_page.md b/docs/webapp/webapp_projects_page.md index ed040d4f..11f36571 100644 --- a/docs/webapp/webapp_projects_page.md +++ b/docs/webapp/webapp_projects_page.md @@ -74,7 +74,7 @@ of a project folder to open its context menu and access the following project ac * **Project Settings** * **General** - Set the project’s name, project path and default output destination * **Scalar View Defaults** - Configure the default scalar view configuration for tasks and models - * **Scalar view setting** - Grouping, X-axis units and plot smoothing (See [Scalar Plot Tools](webapp_exp_track_visual.md#scalar-plot-tools)) + * **Scalar view setting** - Grouping, X-axis units and plot smoothing (see [Scalar Plot Tools](webapp_exp_track_visual.md#scalar-plot-tools)) * **Default scalars** - Choose which metrics are visible by default when viewing task/model scalars. * **New Project** - Create a new project (by default a subproject). * **Move to** - Move the project into another project. If the target project does not exist, it is created on-the-fly.