ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 21:24:49 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

add case sensitivity admonition about parameters and sections (#287)

Browse Source
This commit is contained in:
pollfly 2022-07-11 11:53:19 +03:00 committed by GitHub
parent b9b7e96801
commit fde29db158
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/clearml_sdk/task_sdk.md
View File

@ -523,7 +523,7 @@ To define parameters manually use the [`Task.set_parameters`](../references/sdk/
name-value pairs in a parameter dictionary. name-value pairs in a parameter dictionary.
Parameters can be designated into sections: specify a parameter’s section by prefixing its name, delimited with a slash Parameters can be designated into sections: specify a parameter’s section by prefixing its name, delimited with a slash
(i.e. `section_name/parameter_name’:value`). `General` is the default section. (i.e. `section_name/parameter_name:value`). `General` is the default section.
Call the [`set_parameter`](../references/sdk/task.md#set_parameter) method to set a single parameter. Call the [`set_parameter`](../references/sdk/task.md#set_parameter) method to set a single parameter.
@ -566,7 +566,15 @@ print(task.get_parameters())
``` ```
Access a specific parameter with the [`Task.get_parameter`](../references/sdk/task.md#get_parameter) method specifying Access a specific parameter with the [`Task.get_parameter`](../references/sdk/task.md#get_parameter) method specifying
the parameter name. the parameter name and section.
```python
param = task.get_parameter(name="Args/batch_size")
```
:::note Case sensitivity
The parameters and their section names are case-sensitive
:::
### Tracking Python Objects ### Tracking Python Objects