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

Add Task ID locating tips (#141)

Browse Source
This commit is contained in:
pollfly 2021-12-26 15:09:03 +02:00 committed by GitHub
parent 77ddd5b382
commit 6962630aaa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/clearml_data/clearml_data_cli.md
View File

@ -17,6 +17,11 @@ clearml-data create --project <project_name> --name <dataset_name> --parents <ex
``` ```
Creates a new dataset. <br/> Creates a new dataset. <br/>
:::tip Locating Dataset ID
To locate a dataset's ID, go to the dataset task's info panel in the [WebApp](../webapp/webapp_overview.md). In the top of the panel,
to the right of the dataset task name, click `ID` and the dataset ID appears
:::
**Parameters** **Parameters**
<div className="tbl-cmd"> <div className="tbl-cmd">
@ -31,8 +36,7 @@ Creates a new dataset. <br/>
</div> </div>
:::info
:::important
clearml-data works in a stateful mode so once a new dataset is created, the following commands clearml-data works in a stateful mode so once a new dataset is created, the following commands
do not require the `--id` flag. do not require the `--id` flag.
::: :::

5
docs/clearml_data/clearml_data_sdk.md
View File

@ -40,6 +40,11 @@ dataset = Dataset.create(
) )
``` ```
:::tip Locating Dataset ID
To locate a dataset's ID, go to the dataset task's info panel in the [WebApp](../webapp/webapp_overview.md). In the top of the panel,
to the right of the dataset task name, click `ID` and the dataset ID appears
:::
The created dataset inherits the content of the `parent_datasets`. When multiple dataset parents are listed, The created dataset inherits the content of the `parent_datasets`. When multiple dataset parents are listed,
they are merged in order of specification. Each parent overrides any overlapping files from a previous parent dataset. they are merged in order of specification. Each parent overrides any overlapping files from a previous parent dataset.

6
docs/fundamentals/hpo.md
View File

@ -116,6 +116,12 @@ optimization.
``` ```
<br/> <br/>
:::tip Locating Task ID
To locate the base task's ID, go to the task's info panel in the [WebApp](../webapp/webapp_overview.md). In the top of the panel,
to the right of the task name, click `ID` and the task ID appears
:::
For more information about `HyperParameterOptimizer` and supported optimization modules, see the [HyperParameterOptimizer class reference](../references/sdk/hpo_optimization_hyperparameteroptimizer.md). For more information about `HyperParameterOptimizer` and supported optimization modules, see the [HyperParameterOptimizer class reference](../references/sdk/hpo_optimization_hyperparameteroptimizer.md).
## Tutorial ## Tutorial

5
docs/fundamentals/task.md
View File

@ -209,6 +209,11 @@ See [`Task.create`](../references/sdk/task.md#taskcreate) in the Python SDK refe
A Task can be identified by its project and name, and by a unique identifier (UUID string). The name and project of A Task can be identified by its project and name, and by a unique identifier (UUID string). The name and project of
a Task can be changed after an experiment has been executed, but its ID can't be changed. a Task can be changed after an experiment has been executed, but its ID can't be changed.
:::tip Locating Task IDs
To locate a task ID, go to the task's info panel in the [WebApp](../webapp/webapp_overview.md). In the top of the panel,
to the right of the task name, click `ID` and the task ID appears
:::
Programmatically, Task objects can be retrieved by querying the system based on either the Task ID or a project and name Programmatically, Task objects can be retrieved by querying the system based on either the Task ID or a project and name
combination. If a project / name combination is used, and multiple Tasks have the exact same name, the function will return combination. If a project / name combination is used, and multiple Tasks have the exact same name, the function will return
the *last modified Task*. the *last modified Task*.