From 7f6c2948fcb251838480756d92f69b46aa28d30c Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 16 Nov 2023 17:17:48 +0200 Subject: [PATCH] Add upload link artifact info (#710) --- docs/clearml_sdk/task_sdk.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/clearml_sdk/task_sdk.md b/docs/clearml_sdk/task_sdk.md index aa70f18e..06e06c0d 100644 --- a/docs/clearml_sdk/task_sdk.md +++ b/docs/clearml_sdk/task_sdk.md @@ -603,20 +603,27 @@ Artifacts are the output files created by a task. ClearML uploads and logs these accessed, modified, and used. ### Logging Artifacts -To log an artifact in a task, use the [`upload_artifact`](../references/sdk/task.md#upload_artifact) method. +To log an artifact in a task, use [`upload_artifact()`](../references/sdk/task.md#upload_artifact). For example: * Upload a local file containing the preprocessing results of the data: ```python task.upload_artifact(name='data', artifact_object='/path/to/preprocess_data.csv') ``` - + * Upload an entire folder with all its content by passing the folder, which will be zipped and uploaded as a single zip file: ```python task.upload_artifact(name='folder', artifact_object='/path/to/folder') ``` +* Register links to network-stored objects (i.e. a URL where the scheme is supported by ClearML such as `http://`, `https://`, + `s3://`, `gs://`, or `azure://`). The artifact will only be added as a URL and will not be uploaded. + + ```python + task.upload_artifact(name='link', artifact_object='azure://bucket/folder') + ``` + * Serialize and upload a Python object. ClearML automatically chooses the file format based on the object’s type, or you can explicitly specify the format as follows: * dict - `.json` (default), `.yaml`