diff --git a/clearml/automation/job.py b/clearml/automation/job.py index 35eb261a..c5d2a8d4 100644 --- a/clearml/automation/job.py +++ b/clearml/automation/job.py @@ -148,7 +148,8 @@ class BaseJob(object): def status(self, force=False): # type: (bool) -> str """ - Return the Job Task current status, see Task.TaskStatusEnum + Return the Job Task current status. Options are: "created", "queued", "in_progress", "stopped", "published", + "publishing", "closed", "failed", "completed", "unknown". :param force: Force status update, otherwise, only refresh state every 1 sec @@ -667,7 +668,8 @@ class LocalClearmlJob(ClearmlJob): def status(self, force=False): # type: (bool) -> str """ - Return the Job Task current status, see Task.TaskStatusEnum + Return the Job Task current status. Options are: "created", "queued", "in_progress", "stopped", "published", + "publishing", "closed", "failed", "completed", "unknown". :param force: Force status update, otherwise, only refresh state every 1 sec diff --git a/clearml/backend_interface/task/task.py b/clearml/backend_interface/task/task.py index 75272995..bc2dd988 100644 --- a/clearml/backend_interface/task/task.py +++ b/clearml/backend_interface/task/task.py @@ -1534,8 +1534,24 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin): """ Set the task_type for the Task. - :param task_type: The task_type of the Task (see optional values in TaskTypes). + :param task_type: The task_type of the Task. + + Valid task types: + + - ``TaskTypes.training`` + - ``TaskTypes.testing`` + - ``TaskTypes.inference`` + - ``TaskTypes.data_processing`` + - ``TaskTypes.application`` + - ``TaskTypes.monitor`` + - ``TaskTypes.controller`` + - ``TaskTypes.optimizer`` + - ``TaskTypes.service`` + - ``TaskTypes.qc`` + - ``TaskTypes.custom`` + :type task_type: str or TaskTypes + """ if not isinstance(task_type, self.TaskTypes): task_type = self.TaskTypes(task_type) diff --git a/clearml/task.py b/clearml/task.py index 1f13c17f..9152fa07 100644 --- a/clearml/task.py +++ b/clearml/task.py @@ -858,7 +858,8 @@ class Task(_Task): `parent`: (str) filter by parent task-id matching `search_text`: (str) free text search (in task fields comment/name/id) `status`: List[str] List of valid statuses - (options are: "created", "queued", "in_progress", "stopped", "published", "completed") + (options are: "created", "queued", "in_progress", "stopped", "published", "publishing", "closed", "failed", + "completed", "unknown") `type`: List[str] List of valid task type (options are: 'training', 'testing', 'inference', 'data_processing', 'application', 'monitor', 'controller', 'optimizer', 'service', 'qc'. 'custom') @@ -917,7 +918,8 @@ class Task(_Task): `parent`: (str) filter by parent task-id matching `search_text`: (str) free text search (in task fields comment/name/id) `status`: List[str] List of valid statuses - (options are: "created", "queued", "in_progress", "stopped", "published", "completed") + (options are: "created", "queued", "in_progress", "stopped", "published", "publishing", "closed", "failed", + "completed", "unknown") `type`: List[str] List of valid task type (options are: 'training', 'testing', 'inference', 'data_processing', 'application', 'monitor', 'controller', 'optimizer', 'service', 'qc'. 'custom')