From 04a7436e1bfa7c92c646533632b2c80bbb1244bd Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Wed, 14 Aug 2024 17:21:01 +0300
Subject: [PATCH] Add task argument clarification  (#902)

---
 docs/clearml_sdk/task_sdk.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/clearml_sdk/task_sdk.md b/docs/clearml_sdk/task_sdk.md
index 41767b02..cc198969 100644
--- a/docs/clearml_sdk/task_sdk.md
+++ b/docs/clearml_sdk/task_sdk.md
@@ -214,9 +214,20 @@ task = Task.create(
     script='examples/reporting/html_reporting.py',
     working_directory='.',
     docker=None,
+    argparse_args=[
+      ("lr", 0.01),
+      ("epochs", 10)      
+    ]
 )
 ```
 
+:::info Argument Specification
+When specifying arguments in `argparse_args`, use the full argument name (e.g., `--lr`) instead of the short form 
+(e.g., `-l`).  ClearML works by connecting with the argument parser and replacing the associated variable name, not the 
+flag. In most cases, the full argument name and the variable name are the same, but the short version is different and 
+will not work.
+:::
+
 For more information, see [`Task.create()`](../references/sdk/task.md#taskcreate).
 
 ## Tracking Task Progress