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

Update docstring (#1314)

Browse Source
This commit is contained in:
pollfly 2024-08-24 22:11:19 +03:00 committed by GitHub
parent 9a9ee54681
commit 33e4c24b79
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
clearml/task.py
View File

@ -878,11 +878,12 @@ class Task(_Task):
:param task_name: Set the name of the remote task. Required if base_task_id is None. :param task_name: Set the name of the remote task. Required if base_task_id is None.
:param task_type: Optional, The task type to be created. Supported values: 'training', 'testing', 'inference', :param task_type: Optional, The task type to be created. Supported values: 'training', 'testing', 'inference',
'data_processing', 'application', 'monitor', 'controller', 'optimizer', 'service', 'qc', 'custom' 'data_processing', 'application', 'monitor', 'controller', 'optimizer', 'service', 'qc', 'custom'
:param repo: Remote URL for the repository to use, or path to local copy of the git repository :param repo: Remote URL for the repository to use, or path to local copy of the git repository.
Example: 'https://github.com/allegroai/clearml.git' or '~/project/repo' Example: 'https://github.com/allegroai/clearml.git' or '~/project/repo'. If ``repo`` is specified, then
the ``script`` parameter must also be specified
:param branch: Select specific repository branch/tag (implies the latest commit from the branch) :param branch: Select specific repository branch/tag (implies the latest commit from the branch)
:param commit: Select specific commit ID to use (default: latest commit, :param commit: Select specific commit ID to use (default: latest commit,
or when used with local repository matching the local commit id) or when used with local repository matching the local commit ID)
:param script: Specify the entry point script for the remote execution. When used in tandem with :param script: Specify the entry point script for the remote execution. When used in tandem with
remote git repository the script should be a relative path inside the repository, remote git repository the script should be a relative path inside the repository,
for example: './source/train.py' . When used with local repository path it supports a for example: './source/train.py' . When used with local repository path it supports a