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

Add ClearML object length comment (#51)

Browse Source
This commit is contained in:
pollfly 2021-08-25 09:40:17 +03:00 committed by GitHub
parent 77f370613c
commit eff61fa350
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/fundamentals/task.md
View File

@ -9,7 +9,7 @@ or any custom implementation you choose.
To transform an existing script into a **ClearML Task**, one must call the [Task.init()](../references/sdk/task.md#taskinit) method To transform an existing script into a **ClearML Task**, one must call the [Task.init()](../references/sdk/task.md#taskinit) method
and specify a task name and its project. This creates a Task object that automatically captures code execution and specify a task name and its project. This creates a Task object that automatically captures code execution
information as well as execution outputs. information as well as execution outputs.
All the information captured by a task is by default uploaded to the [ClearML Server](../deploying_clearml/clearml_server.md) All the information captured by a task is by default uploaded to the [ClearML Server](../deploying_clearml/clearml_server.md)
and it can be visualized in the [ClearML WebApp](../webapp/webapp_overview.md) (UI). ClearML can also be configured to upload and it can be visualized in the [ClearML WebApp](../webapp/webapp_overview.md) (UI). ClearML can also be configured to upload
@ -130,13 +130,17 @@ The following table describes the Task states and state transitions.
* Argparse arguments (default and specific to the current execution) * Argparse arguments (default and specific to the current execution)
* Reports to Tensorboard & Matplotlib and model checkpoints. * Reports to Tensorboard & Matplotlib and model checkpoints.
:::note
ClearML object (e.g. task, project) names are required to be at least 3 characters long
:::
```python ```python
from clearml import Task from clearml import Task
task = Task.init( task = Task.init(
project_name='example', project_name='example', # project name of at least 3 characters
task_name='task template', task_name='task template', # task name of at least 3 characters
task_type=None, task_type=None,
tags=None, tags=None,
reuse_last_task_id=True, reuse_last_task_id=True,