diff --git a/docs/clearml_data/clearml_data_cli.md b/docs/clearml_data/clearml_data_cli.md index db86db5d..f94fde56 100644 --- a/docs/clearml_data/clearml_data_cli.md +++ b/docs/clearml_data/clearml_data_cli.md @@ -17,6 +17,11 @@ clearml-data create --project --name --parents +:::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**
@@ -31,8 +36,7 @@ Creates a new dataset.
- -:::important +:::info clearml-data works in a stateful mode so once a new dataset is created, the following commands do not require the `--id` flag. ::: diff --git a/docs/clearml_data/clearml_data_sdk.md b/docs/clearml_data/clearml_data_sdk.md index aabb11b0..3dac8093 100644 --- a/docs/clearml_data/clearml_data_sdk.md +++ b/docs/clearml_data/clearml_data_sdk.md @@ -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, they are merged in order of specification. Each parent overrides any overlapping files from a previous parent dataset. diff --git a/docs/fundamentals/hpo.md b/docs/fundamentals/hpo.md index 76074f35..e8fda619 100644 --- a/docs/fundamentals/hpo.md +++ b/docs/fundamentals/hpo.md @@ -116,6 +116,12 @@ optimization. ```
+:::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). ## Tutorial diff --git a/docs/fundamentals/task.md b/docs/fundamentals/task.md index 9eb25034..f72e6640 100644 --- a/docs/fundamentals/task.md +++ b/docs/fundamentals/task.md @@ -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 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 combination. If a project / name combination is used, and multiple Tasks have the exact same name, the function will return the *last modified Task*.