ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-31 06:27:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add upload link artifact info (#710)

Browse Source
This commit is contained in:
pollfly 2023-11-16 17:17:48 +02:00 committed by GitHub
parent 8273e3b08e
commit 7f6c2948fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/clearml_sdk/task_sdk.md
View File

@ -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`