From 12e6cade6377629e067736f7a32632f9abcfcdaa Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Mon, 28 Oct 2024 10:45:37 +0200
Subject: [PATCH] Add sdk.development.artifacts.auto_pickle option (#951)

---
 docs/configs/clearml_conf.md | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md
index c26b12ee..edeebc5a 100644
--- a/docs/configs/clearml_conf.md
+++ b/docs/configs/clearml_conf.md
@@ -1043,11 +1043,18 @@ URL to a CA bundle, or set this option to `false` to skip SSL certificate verifi
     
 ---
 
-**`sdk.development.default_pandas_dataframe_extension_name`** (*string*)
-
-* Set the default `extension_name` for pandas `DataFrame` objects 
-* Valid values are: `.csv.gz`, `.parquet`, `.feather`, `.pickle`
-* This value can be overridden by the `extension_name` argument supplied to `Task.upload_artifact()`
+**`sdk.development.artifacts`** (*dict*)
+* Control default behavior when logging task artifacts:
+  * **`sdk.development.artifacts.default_pandas_dataframe_extension_name`** (*str*)
+    * Set the default `extension_name` for pandas `DataFrame` objects 
+    * Valid values are: `.csv.gz`, `.parquet`, `.feather`, `.pickle`
+    * This value can be overridden by the `extension_name` argument supplied to `Task.upload_artifact()`
+  * **`sdk.development.artifacts.auto_pickle`** (*bool*)
+    * If `true` and the artifact is not of a specific type (`pathlib2.Path`, `dict`, `pandas.DataFrame`, `numpy.ndarray`, 
+    `PIL.Image`, url string, `local_file` string), the artifact will be
+    pickled and uploaded as a pickle file artifact (with the `.pkl` file extension).
+    * If `false`, the auto-pickle behavior is disabled in the artifact upload
+    * This value can be overridden by the `auto_pickle` argument supplied to `Task.upload_artifact()` 
 
 ---