From 525f41dcc5a65fa1c1f213574a6af6e44669d35d Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 13 Feb 2025 08:19:40 +0200 Subject: [PATCH] Fix links (#1040) --- docs/clearml_data/clearml_data_sdk.md | 2 +- docs/clearml_serving/clearml_serving_tutorial.md | 2 +- docs/fundamentals/artifacts.md | 2 +- docs/guides/pipeline/pipeline_decorator.md | 4 ++-- docs/hyperdatasets/webapp/webapp_dataviews.md | 2 +- docs/integrations/splunk.md | 2 +- docs/webapp/settings/webapp_settings_access_rules.md | 2 +- docs/webapp/settings/webapp_settings_overview.md | 2 +- docs/webapp/settings/webapp_settings_users.md | 2 +- docs/webapp/webapp_exp_track_visual.md | 2 ++ docs/webapp/webapp_model_comparing.md | 2 +- 11 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/clearml_data/clearml_data_sdk.md b/docs/clearml_data/clearml_data_sdk.md index bfc7e25c..8db5d204 100644 --- a/docs/clearml_data/clearml_data_sdk.md +++ b/docs/clearml_data/clearml_data_sdk.md @@ -331,7 +331,7 @@ Dataset.rename( ``` ## Moving Datasets to Another Project -Move a dataset to another project using the [`Dataset.move_to_project()`](../references/sdk/dataset.md#datasetmove_to_projetc) +Move a dataset to another project using the [`Dataset.move_to_project()`](../references/sdk/dataset.md#datasetmove_to_project) class method. All the datasets with the given `dataset_project` and `dataset_name` will be moved to the new dataset project. diff --git a/docs/clearml_serving/clearml_serving_tutorial.md b/docs/clearml_serving/clearml_serving_tutorial.md index 3d5ef43e..2fad3a66 100644 --- a/docs/clearml_serving/clearml_serving_tutorial.md +++ b/docs/clearml_serving/clearml_serving_tutorial.md @@ -88,7 +88,7 @@ Uploading an existing model file into the model repository can be done via the ` or with the `clearml-serving` CLI. 1. Upload the model file to the `clearml-server` file storage and register it. The `--path` parameter is used to input - the path to a local model file (local model created in [step 1](#step-1--train-model) located in `./sklearn-model.pkl`). + the path to a local model file (local model created in [step 1](#step-1-train-model) located in `./sklearn-model.pkl`). ```bash clearml-serving --id model upload --name "manual sklearn model" --project "serving examples" --framework "scikitlearn" --path ./sklearn-model.pkl diff --git a/docs/fundamentals/artifacts.md b/docs/fundamentals/artifacts.md index 79a7f441..adee8ed1 100644 --- a/docs/fundamentals/artifacts.md +++ b/docs/fundamentals/artifacts.md @@ -25,7 +25,7 @@ cleaning task logs its clean dataset for use by a subsequent training task). ## Logging Artifacts ClearML automatically logs artifacts created by popular frameworks, including TensorFlow and PyTorch. See [supported frameworks](../clearml_sdk/task_sdk.md#automatic-logging). -You can also log any other object using [`Task.upload_artifact()`](../references/sdk/task.md#upload_)artifact. See +You can also log any other object using [`Task.upload_artifact()`](../references/sdk/task.md#upload_artifact). See the [Artifacts Reporting](../guides/reporting/artifacts.md) example for details. ClearML can be configured to upload artifacts to any supported types of storage, which include local and shared folders, diff --git a/docs/guides/pipeline/pipeline_decorator.md b/docs/guides/pipeline/pipeline_decorator.md index 7733abdc..f8f55ef6 100644 --- a/docs/guides/pipeline/pipeline_decorator.md +++ b/docs/guides/pipeline/pipeline_decorator.md @@ -39,8 +39,8 @@ In the example script, the controller defines the interactions between the pipel :::info Local Execution In this example, the pipeline is set to run in local mode by using -the PipelineDecorator.run_locally -method before calling the pipeline function. See pipeline execution options [here](../../pipelines/pipelines_sdk_function_decorators.md#running-the-pipeline). +[`PipelineDecorator.run_locally()`](../../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorrun_locally) +before calling the pipeline function. See pipeline execution options [here](../../pipelines/pipelines_sdk_function_decorators.md#running-the-pipeline). ::: ## Pipeline Steps diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index e43a04df..a1bf2111 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -2,7 +2,7 @@ title: The Dataview table --- -The **Dataview table** is a [customizable](#customizing-the-dataviews-table) list of Dataviews associated with a project. +The **Dataview table** is a [customizable](#customizing-the-dataview-table) list of Dataviews associated with a project. Use it to view and create Dataviews, and access their info panels. The table lists independent Dataview objects. To see Dataviews logged by a task, go diff --git a/docs/integrations/splunk.md b/docs/integrations/splunk.md index 0cd18911..2955d404 100644 --- a/docs/integrations/splunk.md +++ b/docs/integrations/splunk.md @@ -137,7 +137,7 @@ Configure the ClearML server to send API logs to Splunk using [Docker Compose](# To exclude specific API calls from the Splunk logs, add an environment variable with the following format: `CLEARML__apiserver__endpoints______log_call` and set it to `false`. -For example, the configuration below for servers on K8s Helm exclude the [`POST /debug.ping`](../references/api/debug.md##post-debugping) +For example, the configuration below for servers on K8s Helm exclude the [`POST /debug.ping`](../references/api/debug.md#post-debugping) call from the Splunk logs: ``` diff --git a/docs/webapp/settings/webapp_settings_access_rules.md b/docs/webapp/settings/webapp_settings_access_rules.md index 92f756aa..d9576e04 100644 --- a/docs/webapp/settings/webapp_settings_access_rules.md +++ b/docs/webapp/settings/webapp_settings_access_rules.md @@ -26,7 +26,7 @@ Access privileges can be viewed, defined, and edited in the **Access Rules** tab specific project or task), click the input box, and select the object from the list that appears. Filter the list by typing part of the desired object name 1. Select the permission type - **Read Only** or **Read & Modify** -1. Assign users, [service accounts](webapp_settings_access_rules.md#service-accounts), and/or [user groups](webapp_settings_users.md#user-groups) +1. Assign users, [service accounts](webapp_settings_users.md#service-accounts), and/or [user groups](webapp_settings_users.md#user-groups) to be given access. Click the desired input box, and select the users / service accounts / groups from the list that appears. Filter the list by typing part of the desired object name. To revoke diff --git a/docs/webapp/settings/webapp_settings_overview.md b/docs/webapp/settings/webapp_settings_overview.md index 8ffb53b8..a2ea94ec 100644 --- a/docs/webapp/settings/webapp_settings_overview.md +++ b/docs/webapp/settings/webapp_settings_overview.md @@ -12,7 +12,7 @@ The Settings page consists of the following sections: * [Profile](webapp_settings_profile.md#profile) - You basic user information * [Configuration](webapp_settings_profile.md#configuration) - Control general system behavior settings and input storage access credentials * [Workspace](webapp_settings_profile.md#workspace) - * [ClearML credentials](webapp_settings_profile.md#clearml-credentials) - Create client credentials for ClearML and ClearML Agent to use + * [ClearML credentials](webapp_settings_profile.md#clearml-api-credentials) - Create client credentials for ClearML and ClearML Agent to use * [Configuration vault](webapp_settings_profile.md#configuration-vault) (ClearML Enterprise Server) - Define global ClearML client settings that are applied to all ClearML and ClearML Agent instances (which use the workspace's access credentials) diff --git a/docs/webapp/settings/webapp_settings_users.md b/docs/webapp/settings/webapp_settings_users.md index edded1bd..dc0cd40f 100644 --- a/docs/webapp/settings/webapp_settings_users.md +++ b/docs/webapp/settings/webapp_settings_users.md @@ -137,7 +137,7 @@ To apply vault contents: * Click the toggle atop the vault to enable / disable the configurations * Once enabled, the configurations will be merged to the configuration file during ClearML and ClearML Agent usage -In addition to the service account-specific configuration vault, [administrator vaults](#administrator-vaults) can also +In addition to the service account-specific configuration vault, [administrator vaults](webapp_settings_admin_vaults.md) can also be applied to service accounts. See all the vaults applied to the account in the **Applied administrator vaults** below the configuration vault. diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index e4039899..496daa47 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -323,6 +323,8 @@ a `Summary` table. ![Single value scalar plot](../img/webapp_single_scalar_plot.png#light-mode-only) ![Single value scalar plot](../img/webapp_single_scalar_plot_dark.png#dark-mode-only) +#### Scalar Plot Tools + Use the scalar tools to improve analysis of scalar metrics. In the info panel, click Settings gear to use the tools. In the full screen details view, the tools are on the left side of the window. The tools include: diff --git a/docs/webapp/webapp_model_comparing.md b/docs/webapp/webapp_model_comparing.md index 1eb188ec..07be1798 100644 --- a/docs/webapp/webapp_model_comparing.md +++ b/docs/webapp/webapp_model_comparing.md @@ -46,7 +46,7 @@ models update. The Enterprise Plan and Hosted Service support embedding resource The comparison tabs provides the following views: * [Side-by-side textual comparison](#side-by-side-textual-comparison) * [Tabular scalar comparison](#tabular-scalar-comparison) -* [Merged plot comparison](#graphic-comparison) +* [Merged plot comparison](#plot-comparison) * [Side-by-side graphic comparison](#graphic-comparison)