ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-03 10:42:51 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add task argument clarification (#902)

Browse Source
This commit is contained in:
pollfly 2024-08-14 17:21:01 +03:00 committed by GitHub
parent 1dc9e9e81e
commit 04a7436e1b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/clearml_sdk/task_sdk.md
View File

@ -214,9 +214,20 @@ task = Task.create(
script='examples/reporting/html_reporting.py', script='examples/reporting/html_reporting.py',
working_directory='.', working_directory='.',
docker=None, 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). For more information, see [`Task.create()`](../references/sdk/task.md#taskcreate).
## Tracking Task Progress ## Tracking Task Progress