dtlpy 1.113.10__py3-none-any.whl → 1.114.13__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. dtlpy/__init__.py +488 -488
  2. dtlpy/__version__.py +1 -1
  3. dtlpy/assets/__init__.py +26 -26
  4. dtlpy/assets/__pycache__/__init__.cpython-38.pyc +0 -0
  5. dtlpy/assets/code_server/config.yaml +2 -2
  6. dtlpy/assets/code_server/installation.sh +24 -24
  7. dtlpy/assets/code_server/launch.json +13 -13
  8. dtlpy/assets/code_server/settings.json +2 -2
  9. dtlpy/assets/main.py +53 -53
  10. dtlpy/assets/main_partial.py +18 -18
  11. dtlpy/assets/mock.json +11 -11
  12. dtlpy/assets/model_adapter.py +83 -83
  13. dtlpy/assets/package.json +61 -61
  14. dtlpy/assets/package_catalog.json +29 -29
  15. dtlpy/assets/package_gitignore +307 -307
  16. dtlpy/assets/service_runners/__init__.py +33 -33
  17. dtlpy/assets/service_runners/converter.py +96 -96
  18. dtlpy/assets/service_runners/multi_method.py +49 -49
  19. dtlpy/assets/service_runners/multi_method_annotation.py +54 -54
  20. dtlpy/assets/service_runners/multi_method_dataset.py +55 -55
  21. dtlpy/assets/service_runners/multi_method_item.py +52 -52
  22. dtlpy/assets/service_runners/multi_method_json.py +52 -52
  23. dtlpy/assets/service_runners/single_method.py +37 -37
  24. dtlpy/assets/service_runners/single_method_annotation.py +43 -43
  25. dtlpy/assets/service_runners/single_method_dataset.py +43 -43
  26. dtlpy/assets/service_runners/single_method_item.py +41 -41
  27. dtlpy/assets/service_runners/single_method_json.py +42 -42
  28. dtlpy/assets/service_runners/single_method_multi_input.py +45 -45
  29. dtlpy/assets/voc_annotation_template.xml +23 -23
  30. dtlpy/caches/base_cache.py +32 -32
  31. dtlpy/caches/cache.py +473 -473
  32. dtlpy/caches/dl_cache.py +201 -201
  33. dtlpy/caches/filesystem_cache.py +89 -89
  34. dtlpy/caches/redis_cache.py +84 -84
  35. dtlpy/dlp/__init__.py +20 -20
  36. dtlpy/dlp/cli_utilities.py +367 -367
  37. dtlpy/dlp/command_executor.py +764 -764
  38. dtlpy/dlp/dlp +1 -1
  39. dtlpy/dlp/dlp.bat +1 -1
  40. dtlpy/dlp/dlp.py +128 -128
  41. dtlpy/dlp/parser.py +651 -651
  42. dtlpy/entities/__init__.py +83 -83
  43. dtlpy/entities/analytic.py +311 -311
  44. dtlpy/entities/annotation.py +1879 -1879
  45. dtlpy/entities/annotation_collection.py +699 -699
  46. dtlpy/entities/annotation_definitions/__init__.py +20 -20
  47. dtlpy/entities/annotation_definitions/base_annotation_definition.py +100 -100
  48. dtlpy/entities/annotation_definitions/box.py +195 -195
  49. dtlpy/entities/annotation_definitions/classification.py +67 -67
  50. dtlpy/entities/annotation_definitions/comparison.py +72 -72
  51. dtlpy/entities/annotation_definitions/cube.py +204 -204
  52. dtlpy/entities/annotation_definitions/cube_3d.py +149 -149
  53. dtlpy/entities/annotation_definitions/description.py +32 -32
  54. dtlpy/entities/annotation_definitions/ellipse.py +124 -124
  55. dtlpy/entities/annotation_definitions/free_text.py +62 -62
  56. dtlpy/entities/annotation_definitions/gis.py +69 -69
  57. dtlpy/entities/annotation_definitions/note.py +139 -139
  58. dtlpy/entities/annotation_definitions/point.py +117 -117
  59. dtlpy/entities/annotation_definitions/polygon.py +182 -182
  60. dtlpy/entities/annotation_definitions/polyline.py +111 -111
  61. dtlpy/entities/annotation_definitions/pose.py +92 -92
  62. dtlpy/entities/annotation_definitions/ref_image.py +86 -86
  63. dtlpy/entities/annotation_definitions/segmentation.py +240 -240
  64. dtlpy/entities/annotation_definitions/subtitle.py +34 -34
  65. dtlpy/entities/annotation_definitions/text.py +85 -85
  66. dtlpy/entities/annotation_definitions/undefined_annotation.py +74 -74
  67. dtlpy/entities/app.py +220 -220
  68. dtlpy/entities/app_module.py +107 -107
  69. dtlpy/entities/artifact.py +174 -174
  70. dtlpy/entities/assignment.py +399 -399
  71. dtlpy/entities/base_entity.py +214 -214
  72. dtlpy/entities/bot.py +113 -113
  73. dtlpy/entities/codebase.py +296 -296
  74. dtlpy/entities/collection.py +38 -38
  75. dtlpy/entities/command.py +169 -169
  76. dtlpy/entities/compute.py +442 -442
  77. dtlpy/entities/dataset.py +1285 -1285
  78. dtlpy/entities/directory_tree.py +44 -44
  79. dtlpy/entities/dpk.py +470 -470
  80. dtlpy/entities/driver.py +222 -222
  81. dtlpy/entities/execution.py +397 -397
  82. dtlpy/entities/feature.py +124 -124
  83. dtlpy/entities/feature_set.py +145 -145
  84. dtlpy/entities/filters.py +641 -641
  85. dtlpy/entities/gis_item.py +107 -107
  86. dtlpy/entities/integration.py +184 -184
  87. dtlpy/entities/item.py +953 -953
  88. dtlpy/entities/label.py +123 -123
  89. dtlpy/entities/links.py +85 -85
  90. dtlpy/entities/message.py +175 -175
  91. dtlpy/entities/model.py +694 -691
  92. dtlpy/entities/node.py +1005 -1005
  93. dtlpy/entities/ontology.py +803 -803
  94. dtlpy/entities/organization.py +287 -287
  95. dtlpy/entities/package.py +657 -657
  96. dtlpy/entities/package_defaults.py +5 -5
  97. dtlpy/entities/package_function.py +185 -185
  98. dtlpy/entities/package_module.py +113 -113
  99. dtlpy/entities/package_slot.py +118 -118
  100. dtlpy/entities/paged_entities.py +290 -267
  101. dtlpy/entities/pipeline.py +593 -593
  102. dtlpy/entities/pipeline_execution.py +279 -279
  103. dtlpy/entities/project.py +394 -394
  104. dtlpy/entities/prompt_item.py +499 -499
  105. dtlpy/entities/recipe.py +301 -301
  106. dtlpy/entities/reflect_dict.py +102 -102
  107. dtlpy/entities/resource_execution.py +138 -138
  108. dtlpy/entities/service.py +958 -958
  109. dtlpy/entities/service_driver.py +117 -117
  110. dtlpy/entities/setting.py +294 -294
  111. dtlpy/entities/task.py +491 -491
  112. dtlpy/entities/time_series.py +143 -143
  113. dtlpy/entities/trigger.py +426 -426
  114. dtlpy/entities/user.py +118 -118
  115. dtlpy/entities/webhook.py +124 -124
  116. dtlpy/examples/__init__.py +19 -19
  117. dtlpy/examples/add_labels.py +135 -135
  118. dtlpy/examples/add_metadata_to_item.py +21 -21
  119. dtlpy/examples/annotate_items_using_model.py +65 -65
  120. dtlpy/examples/annotate_video_using_model_and_tracker.py +75 -75
  121. dtlpy/examples/annotations_convert_to_voc.py +9 -9
  122. dtlpy/examples/annotations_convert_to_yolo.py +9 -9
  123. dtlpy/examples/convert_annotation_types.py +51 -51
  124. dtlpy/examples/converter.py +143 -143
  125. dtlpy/examples/copy_annotations.py +22 -22
  126. dtlpy/examples/copy_folder.py +31 -31
  127. dtlpy/examples/create_annotations.py +51 -51
  128. dtlpy/examples/create_video_annotations.py +83 -83
  129. dtlpy/examples/delete_annotations.py +26 -26
  130. dtlpy/examples/filters.py +113 -113
  131. dtlpy/examples/move_item.py +23 -23
  132. dtlpy/examples/play_video_annotation.py +13 -13
  133. dtlpy/examples/show_item_and_mask.py +53 -53
  134. dtlpy/examples/triggers.py +49 -49
  135. dtlpy/examples/upload_batch_of_items.py +20 -20
  136. dtlpy/examples/upload_items_and_custom_format_annotations.py +55 -55
  137. dtlpy/examples/upload_items_with_modalities.py +43 -43
  138. dtlpy/examples/upload_segmentation_annotations_from_mask_image.py +44 -44
  139. dtlpy/examples/upload_yolo_format_annotations.py +70 -70
  140. dtlpy/exceptions.py +125 -125
  141. dtlpy/miscellaneous/__init__.py +20 -20
  142. dtlpy/miscellaneous/dict_differ.py +95 -95
  143. dtlpy/miscellaneous/git_utils.py +217 -217
  144. dtlpy/miscellaneous/json_utils.py +14 -14
  145. dtlpy/miscellaneous/list_print.py +105 -105
  146. dtlpy/miscellaneous/zipping.py +130 -130
  147. dtlpy/ml/__init__.py +20 -20
  148. dtlpy/ml/base_feature_extractor_adapter.py +27 -27
  149. dtlpy/ml/base_model_adapter.py +945 -940
  150. dtlpy/ml/metrics.py +461 -461
  151. dtlpy/ml/predictions_utils.py +274 -274
  152. dtlpy/ml/summary_writer.py +57 -57
  153. dtlpy/ml/train_utils.py +60 -60
  154. dtlpy/new_instance.py +252 -252
  155. dtlpy/repositories/__init__.py +56 -56
  156. dtlpy/repositories/analytics.py +85 -85
  157. dtlpy/repositories/annotations.py +916 -916
  158. dtlpy/repositories/apps.py +383 -383
  159. dtlpy/repositories/artifacts.py +452 -452
  160. dtlpy/repositories/assignments.py +599 -599
  161. dtlpy/repositories/bots.py +213 -213
  162. dtlpy/repositories/codebases.py +559 -559
  163. dtlpy/repositories/collections.py +332 -348
  164. dtlpy/repositories/commands.py +158 -158
  165. dtlpy/repositories/compositions.py +61 -61
  166. dtlpy/repositories/computes.py +434 -406
  167. dtlpy/repositories/datasets.py +1291 -1291
  168. dtlpy/repositories/downloader.py +895 -895
  169. dtlpy/repositories/dpks.py +433 -433
  170. dtlpy/repositories/drivers.py +266 -266
  171. dtlpy/repositories/executions.py +817 -817
  172. dtlpy/repositories/feature_sets.py +226 -226
  173. dtlpy/repositories/features.py +238 -238
  174. dtlpy/repositories/integrations.py +484 -484
  175. dtlpy/repositories/items.py +909 -915
  176. dtlpy/repositories/messages.py +94 -94
  177. dtlpy/repositories/models.py +877 -867
  178. dtlpy/repositories/nodes.py +80 -80
  179. dtlpy/repositories/ontologies.py +511 -511
  180. dtlpy/repositories/organizations.py +525 -525
  181. dtlpy/repositories/packages.py +1941 -1941
  182. dtlpy/repositories/pipeline_executions.py +448 -448
  183. dtlpy/repositories/pipelines.py +642 -642
  184. dtlpy/repositories/projects.py +539 -539
  185. dtlpy/repositories/recipes.py +399 -399
  186. dtlpy/repositories/resource_executions.py +137 -137
  187. dtlpy/repositories/schema.py +120 -120
  188. dtlpy/repositories/service_drivers.py +213 -213
  189. dtlpy/repositories/services.py +1704 -1704
  190. dtlpy/repositories/settings.py +339 -339
  191. dtlpy/repositories/tasks.py +1124 -1124
  192. dtlpy/repositories/times_series.py +278 -278
  193. dtlpy/repositories/triggers.py +536 -536
  194. dtlpy/repositories/upload_element.py +257 -257
  195. dtlpy/repositories/uploader.py +651 -651
  196. dtlpy/repositories/webhooks.py +249 -249
  197. dtlpy/services/__init__.py +22 -22
  198. dtlpy/services/aihttp_retry.py +131 -131
  199. dtlpy/services/api_client.py +1782 -1782
  200. dtlpy/services/api_reference.py +40 -40
  201. dtlpy/services/async_utils.py +133 -133
  202. dtlpy/services/calls_counter.py +44 -44
  203. dtlpy/services/check_sdk.py +68 -68
  204. dtlpy/services/cookie.py +115 -115
  205. dtlpy/services/create_logger.py +156 -156
  206. dtlpy/services/events.py +84 -84
  207. dtlpy/services/logins.py +235 -235
  208. dtlpy/services/reporter.py +256 -256
  209. dtlpy/services/service_defaults.py +91 -91
  210. dtlpy/utilities/__init__.py +20 -20
  211. dtlpy/utilities/annotations/__init__.py +16 -16
  212. dtlpy/utilities/annotations/annotation_converters.py +269 -269
  213. dtlpy/utilities/base_package_runner.py +264 -264
  214. dtlpy/utilities/converter.py +1650 -1650
  215. dtlpy/utilities/dataset_generators/__init__.py +1 -1
  216. dtlpy/utilities/dataset_generators/dataset_generator.py +670 -670
  217. dtlpy/utilities/dataset_generators/dataset_generator_tensorflow.py +23 -23
  218. dtlpy/utilities/dataset_generators/dataset_generator_torch.py +21 -21
  219. dtlpy/utilities/local_development/__init__.py +1 -1
  220. dtlpy/utilities/local_development/local_session.py +179 -179
  221. dtlpy/utilities/reports/__init__.py +2 -2
  222. dtlpy/utilities/reports/figures.py +343 -343
  223. dtlpy/utilities/reports/report.py +71 -71
  224. dtlpy/utilities/videos/__init__.py +17 -17
  225. dtlpy/utilities/videos/video_player.py +598 -598
  226. dtlpy/utilities/videos/videos.py +470 -470
  227. {dtlpy-1.113.10.data → dtlpy-1.114.13.data}/scripts/dlp +1 -1
  228. dtlpy-1.114.13.data/scripts/dlp.bat +2 -0
  229. {dtlpy-1.113.10.data → dtlpy-1.114.13.data}/scripts/dlp.py +128 -128
  230. {dtlpy-1.113.10.dist-info → dtlpy-1.114.13.dist-info}/LICENSE +200 -200
  231. {dtlpy-1.113.10.dist-info → dtlpy-1.114.13.dist-info}/METADATA +172 -172
  232. dtlpy-1.114.13.dist-info/RECORD +240 -0
  233. {dtlpy-1.113.10.dist-info → dtlpy-1.114.13.dist-info}/WHEEL +1 -1
  234. tests/features/environment.py +551 -550
  235. dtlpy-1.113.10.data/scripts/dlp.bat +0 -2
  236. dtlpy-1.113.10.dist-info/RECORD +0 -244
  237. tests/assets/__init__.py +0 -0
  238. tests/assets/models_flow/__init__.py +0 -0
  239. tests/assets/models_flow/failedmain.py +0 -52
  240. tests/assets/models_flow/main.py +0 -62
  241. tests/assets/models_flow/main_model.py +0 -54
  242. {dtlpy-1.113.10.dist-info → dtlpy-1.114.13.dist-info}/entry_points.txt +0 -0
  243. {dtlpy-1.113.10.dist-info → dtlpy-1.114.13.dist-info}/top_level.txt +0 -0
dtlpy/entities/task.py CHANGED
@@ -1,491 +1,491 @@
1
- import traceback
2
- from enum import Enum
3
- from typing import Union, List
4
- import attr
5
- import logging
6
-
7
- from .. import repositories, entities, exceptions
8
-
9
- logger = logging.getLogger(name='dtlpy')
10
-
11
-
12
- class ConsensusTaskType(str, Enum):
13
- CONSENSUS = 'consensus'
14
- QUALIFICATION = 'qualification'
15
- HONEYPOT = 'honeypot'
16
-
17
- class TaskPriority(int, Enum):
18
- LOW = 1
19
- MEDIUM = 2
20
- HIGH = 3
21
-
22
-
23
- class ItemAction:
24
- def __init__(self, action, display_name=None, color='#FFFFFF', icon=None):
25
- if not action or not isinstance(action, str):
26
- raise ValueError('action should be a non-empty string')
27
- self.action = action
28
- if not display_name:
29
- display_name = action
30
- self.display_name = display_name
31
- self.color = color
32
- self.icon = icon
33
-
34
- @classmethod
35
- def from_json(cls, _json: dict):
36
- kwarg = {
37
- 'action': _json.get('action')
38
- }
39
-
40
- if _json.get('displayName', False):
41
- kwarg['display_name'] = _json['displayName']
42
-
43
- if _json.get('color', False):
44
- kwarg['color'] = _json['color']
45
-
46
- if _json.get('icon', False):
47
- kwarg['icon'] = _json['icon']
48
-
49
- return cls(**kwarg)
50
-
51
- def to_json(self) -> dict:
52
- _json = {
53
- 'action': self.action,
54
- 'color': self.color,
55
- 'displayName': self.display_name if self.display_name is not None else self.action
56
- }
57
-
58
- if self.icon is not None:
59
- _json['icon'] = self.icon
60
-
61
- return _json
62
-
63
-
64
- @attr.s
65
- class Task:
66
- """
67
- Task object
68
- """
69
-
70
- # platform
71
- name = attr.ib()
72
- status = attr.ib()
73
- project_id = attr.ib()
74
- metadata = attr.ib(repr=False)
75
- id = attr.ib()
76
- url = attr.ib(repr=False)
77
- task_owner = attr.ib(repr=False)
78
- item_status = attr.ib(repr=False)
79
- creator = attr.ib()
80
- due_date = attr.ib()
81
- dataset_id = attr.ib()
82
- spec = attr.ib()
83
- recipe_id = attr.ib(repr=False)
84
- query = attr.ib(repr=False)
85
- assignmentIds = attr.ib(repr=False)
86
- annotation_status = attr.ib(repr=False)
87
- progress = attr.ib()
88
- for_review = attr.ib()
89
- issues = attr.ib()
90
- updated_at = attr.ib()
91
- created_at = attr.ib()
92
- available_actions = attr.ib()
93
- total_items = attr.ib()
94
- priority = attr.ib()
95
- _description = attr.ib()
96
-
97
- # sdk
98
- _client_api = attr.ib(repr=False)
99
- _current_assignments = attr.ib(default=None, repr=False)
100
- _assignments = attr.ib(default=None, repr=False)
101
- _project = attr.ib(default=None, repr=False)
102
- _dataset = attr.ib(default=None, repr=False)
103
- _tasks = attr.ib(default=None, repr=False)
104
- _settings = attr.ib(default=None, repr=False)
105
-
106
- @property
107
- def description(self):
108
- return self._description
109
-
110
- @description.setter
111
- def description(self, description):
112
- if not isinstance(description, str):
113
- raise ValueError('description should be a string')
114
- if self._description is None:
115
- self._description = {}
116
- self._description['content'] = description
117
-
118
- @staticmethod
119
- def _protected_from_json(_json, client_api, project=None, dataset=None):
120
- """
121
- Same as from_json but with try-except to catch if error
122
-
123
- :param dict _json: platform json that describe the task
124
- :param client_api: ApiClient object
125
- :param dtlpy.entities.project.Project project: project object where task will create
126
- :param dtlpy.entities.dataset.Dataset dataset: dataset object that refer to the task
127
- :return:
128
- """
129
- try:
130
- task = Task.from_json(
131
- _json=_json,
132
- client_api=client_api,
133
- project=project,
134
- dataset=dataset
135
- )
136
- status = True
137
- except Exception:
138
- task = traceback.format_exc()
139
- status = False
140
- return status, task
141
-
142
- @classmethod
143
- def from_json(cls, _json, client_api, project=None, dataset=None):
144
- """
145
- Return the task object form the json
146
-
147
- :param dict _json: platform json that describe the task
148
- :param client_api: ApiClient object
149
- :param dtlpy.entities.project.Project project: project object where task will create
150
- :param dtlpy.entities.dataset.Dataset dataset: dataset object that refer to the task
151
- :return:
152
- """
153
- if project is not None:
154
- if project.id != _json.get('projectId', None):
155
- logger.warning('Task has been fetched from a project that is not belong to it')
156
- project = None
157
-
158
- if dataset is not None:
159
- if dataset.id != _json.get('datasetId', None):
160
- logger.warning('Task has been fetched from a dataset that is not belong to it')
161
- dataset = None
162
-
163
- actions = [ItemAction.from_json(_json=action) for action in _json.get('availableActions', list())]
164
-
165
- return cls(
166
- name=_json.get('name', None),
167
- status=_json.get('status', None),
168
- project_id=_json.get('projectId', None),
169
- metadata=_json.get('metadata', dict()),
170
- url=_json.get('url', None),
171
- spec=_json.get('spec', None),
172
- id=_json['id'],
173
- creator=_json.get('creator', None),
174
- due_date=_json.get('dueDate', 0),
175
- dataset_id=_json.get('datasetId', None),
176
- recipe_id=_json.get('recipeId', None),
177
- query=_json.get('query', None),
178
- task_owner=_json.get('taskOwner', None),
179
- item_status=_json.get('itemStatus', None),
180
- assignmentIds=_json.get('assignmentIds', list()),
181
- dataset=dataset,
182
- project=project,
183
- client_api=client_api,
184
- annotation_status=_json.get('annotationStatus', None),
185
- progress=_json.get('progress', None),
186
- for_review=_json.get('forReview', None),
187
- issues=_json.get('issues', None),
188
- updated_at=_json.get('updatedAt', None),
189
- created_at=_json.get('createdAt', None),
190
- available_actions=actions,
191
- total_items=_json.get('totalItems', None),
192
- priority=_json.get('priority', None),
193
- description=_json.get('description', None)
194
- )
195
-
196
- def to_json(self):
197
- """
198
- Returns platform _json format of object
199
-
200
- :return: platform json format of object
201
- :rtype: dict
202
- """
203
- _json = attr.asdict(
204
- self, filter=attr.filters.exclude(
205
- attr.fields(Task)._client_api,
206
- attr.fields(Task)._project,
207
- attr.fields(Task).project_id,
208
- attr.fields(Task).dataset_id,
209
- attr.fields(Task).recipe_id,
210
- attr.fields(Task).task_owner,
211
- attr.fields(Task).available_actions,
212
- attr.fields(Task).item_status,
213
- attr.fields(Task).due_date,
214
- attr.fields(Task)._tasks,
215
- attr.fields(Task)._dataset,
216
- attr.fields(Task)._current_assignments,
217
- attr.fields(Task)._assignments,
218
- attr.fields(Task).annotation_status,
219
- attr.fields(Task).for_review,
220
- attr.fields(Task).issues,
221
- attr.fields(Task).updated_at,
222
- attr.fields(Task).created_at,
223
- attr.fields(Task).total_items,
224
- attr.fields(Task)._settings,
225
- attr.fields(Task)._description
226
- )
227
- )
228
- _json['projectId'] = self.project_id
229
- _json['datasetId'] = self.dataset_id
230
- _json['recipeId'] = self.recipe_id
231
- _json['taskOwner'] = self.task_owner
232
- _json['dueDate'] = self.due_date
233
- _json['totalItems'] = self.total_items
234
- _json['forReview'] = self.for_review
235
- _json['description'] = self.description
236
-
237
- if self.available_actions is not None:
238
- _json['availableActions'] = [action.to_json() for action in self.available_actions]
239
-
240
- return _json
241
-
242
- @property
243
- def platform_url(self):
244
- return self._client_api._get_resource_url("projects/{}/tasks/{}".format(self.project.id, self.id))
245
-
246
- @property
247
- def current_assignments(self):
248
- if self._current_assignments is None:
249
- self._current_assignments = list()
250
- for assignment in self.assignmentIds:
251
- self._current_assignments.append(self.assignments.get(assignment_id=assignment))
252
- return self._current_assignments
253
-
254
- @property
255
- def assignments(self):
256
- if self._assignments is None:
257
- self._assignments = repositories.Assignments(client_api=self._client_api, dataset=self._dataset,
258
- project=self.project, task=self, project_id=self.project_id)
259
- assert isinstance(self._assignments, repositories.Assignments)
260
- return self._assignments
261
-
262
- @property
263
- def tasks(self):
264
- if self._tasks is None:
265
- self._tasks = repositories.Tasks(client_api=self._client_api, project=self.project, dataset=self.dataset)
266
- assert isinstance(self._tasks, repositories.Tasks)
267
- return self._tasks
268
-
269
- @property
270
- def settings(self):
271
- if self._settings is None:
272
- self._settings = repositories.Settings(
273
- client_api=self._client_api,
274
- project=self.project,
275
- dataset=self.dataset,
276
- task=self
277
- )
278
- assert isinstance(self._settings, repositories.Settings)
279
- return self._settings
280
-
281
- @property
282
- def project(self):
283
- if self._project is None:
284
- self.get_project()
285
- if self._project is None:
286
- raise exceptions.PlatformException(error='2001',
287
- message='Missing entity "project". need to "get_project()" ')
288
- assert isinstance(self._project, entities.Project)
289
- return self._project
290
-
291
- @property
292
- def dataset(self):
293
- if self._dataset is None:
294
- self.get_dataset()
295
- if self._dataset is None:
296
- raise exceptions.PlatformException(error='2001',
297
- message='Missing entity "dataset". need to "get_dataset()" ')
298
- assert isinstance(self._dataset, entities.Dataset)
299
- return self._dataset
300
-
301
- def get_project(self):
302
- if self._project is None:
303
- self._project = repositories.Projects(client_api=self._client_api).get(project_id=self.project_id)
304
-
305
- def get_dataset(self):
306
- if self._dataset is None:
307
- self._dataset = repositories.Datasets(client_api=self._client_api, project=self._project).get(
308
- dataset_id=self.dataset_id)
309
-
310
- def open_in_web(self):
311
- """
312
- Open the task in web platform
313
-
314
- :return:
315
- """
316
- self._client_api._open_in_web(url=self.platform_url)
317
-
318
- def delete(self, wait=True):
319
- """
320
- Delete task from platform
321
-
322
- :param bool wait: wait until delete task finish
323
- :return: True
324
- :rtype: bool
325
- """
326
- return self.tasks.delete(task_id=self.id, wait=wait)
327
-
328
- def update(self, system_metadata=False):
329
- """
330
- Update an Annotation Task
331
-
332
- :param bool system_metadata: DEPRECATED
333
- """
334
- return self.tasks.update(task=self, system_metadata=system_metadata)
335
-
336
- def create_qa_task(self,
337
- due_date,
338
- assignee_ids,
339
- filters=None,
340
- items=None,
341
- query=None,
342
- workload=None,
343
- metadata=None,
344
- available_actions=None,
345
- wait=True,
346
- batch_size=None,
347
- max_batch_workload=None,
348
- allowed_assignees=None,
349
- priority=TaskPriority.MEDIUM
350
- ):
351
- """
352
- Create a new QA Task
353
-
354
- :param float due_date: date by which the QA task should be finished; for example, due_date=datetime.datetime(day=1, month=1, year=2029).timestamp()
355
- :param list assignee_ids: list the QA task assignees (contributors) that should be working on the task. Provide a list of users' emails
356
- :param entities.Filters filters: dl.Filters entity to filter items for the task
357
- :param List[entities.Item] items: list of items (item Id or objects) to insert to the task
358
- :param dict DQL query: filter items for the task
359
- :param List[WorkloadUnit] workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]
360
- :param dict metadata: metadata for the task
361
- :param list available_actions: list of available actions (statuses) that will be available for the task items; The default statuses are: "approved" and "discard"
362
- :param bool wait: wait until create task finish
363
- :param int batch_size: Pulling batch size (items), use with pulling allocation method. Restrictions - Min 3, max 100
364
- :param int max_batch_workload: Max items in assignment, use with pulling allocation method. Restrictions - Min batchSize + 2, max batchSize * 2
365
- :param list allowed_assignees: list the task assignees (contributors) that should be working on the task. Provide a list of users' emails
366
- :param entities.TaskPriority priority: priority of the task options in entities.TaskPriority
367
- :return: task object
368
- :rtype: dtlpy.entities.task.Task
369
-
370
- **Example**:
371
-
372
- .. code-block:: python
373
-
374
- task = task.create_qa_task(due_date = datetime.datetime(day= 1, month= 1, year= 2029).timestamp(),
375
- assignee_ids =[ 'annotator1@dataloop.ai', 'annotator2@dataloop.ai'])
376
- """
377
- return self.tasks.create_qa_task(task=self,
378
- due_date=due_date,
379
- assignee_ids=assignee_ids,
380
- filters=filters,
381
- items=items,
382
- query=query,
383
- workload=workload,
384
- metadata=metadata,
385
- available_actions=available_actions,
386
- wait=wait,
387
- batch_size=batch_size,
388
- max_batch_workload=max_batch_workload,
389
- allowed_assignees=allowed_assignees,
390
- priority=priority
391
- )
392
-
393
- def create_assignment(self, assignment_name, assignee_id, items=None, filters=None):
394
- """
395
- Create a new assignment
396
-
397
- :param str assignment_name: assignment name
398
- :param str assignee_id: the assignment assignees (contributors) that should be working on the task. Provide a user email
399
- :param List[entities.Item] items: list of items (item Id or objects) to insert to the task
400
- :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
401
- :return: Assignment object
402
- :rtype: dtlpy.entities.assignment.Assignment assignment
403
-
404
- **Example**:
405
-
406
- .. code-block:: python
407
-
408
- assignment = task.create_assignment(assignee_id='annotator1@dataloop.ai')
409
- """
410
- assignment = self.assignments.create(assignee_id=assignee_id,
411
- filters=filters,
412
- items=items)
413
-
414
- assignment.metadata['system']['taskId'] = self.id
415
- assignment.update(system_metadata=True)
416
- self.assignmentIds.append(assignment.id)
417
- self.update()
418
- self.add_items(filters=filters, items=items)
419
- return assignment
420
-
421
- def add_items(self, filters=None, items=None, assignee_ids=None, workload=None, limit=None, wait=True, query=None):
422
- """
423
- Add items to Task
424
-
425
- :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
426
- :param list items: list of items (item Ids or objects) to add to the task
427
- :param list assignee_ids: list to assignee who works in the task
428
- :param list workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]
429
- :param int limit: the limit items that task can include
430
- :param bool wait: wait until add items will to finish
431
- :param dict query: query to filter the items for the task
432
-
433
- :return: task entity
434
- :rtype: dtlpy.entities.task.Task
435
- """
436
- return self.tasks.add_items(task=self,
437
- filters=filters,
438
- items=items,
439
- assignee_ids=assignee_ids,
440
- workload=workload,
441
- limit=limit,
442
- wait=wait,
443
- query=query)
444
-
445
- def remove_items(self,
446
- filters: entities.Filters = None,
447
- query=None,
448
- items=None,
449
- wait=True):
450
- """
451
- remove items from Task.
452
-
453
- **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned to be *owner* of the annotation task.
454
-
455
- :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
456
- :param dict query: query to filter the items use it
457
- :param list items: list of items to add to the task
458
- :param bool wait: wait until remove items finish
459
-
460
- :return: True if success and an error if failed
461
- :rtype: bool
462
- """
463
- return self.tasks.remove_items(task=self,
464
- query=query,
465
- filters=filters,
466
- items=items,
467
- wait=wait)
468
-
469
- def get_items(self, filters=None, get_consensus_items: bool = False):
470
- """
471
- Get the task items
472
-
473
- :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
474
- :return: list of the items or PagedEntity output of items
475
- :rtype: list or dtlpy.entities.paged_entities.PagedEntities
476
- """
477
- return self.tasks.get_items(task_id=self.id, dataset=self.dataset, filters=filters, get_consensus_items=get_consensus_items)
478
-
479
- def set_status(self, status: str, operation: str, item_ids: List[str]):
480
- """
481
- Update item status within task
482
-
483
- :param str status: string the describes the status
484
- :param str operation: the status action need 'create' or 'delete'
485
- :param list item_ids: List[str] id items ids
486
-
487
- :return: True if success
488
- :rtype: bool
489
- """
490
- return self.tasks.set_status(status=status, operation=operation, item_ids=item_ids, task_id=self.id)
491
-
1
+ import traceback
2
+ from enum import Enum
3
+ from typing import Union, List
4
+ import attr
5
+ import logging
6
+
7
+ from .. import repositories, entities, exceptions
8
+
9
+ logger = logging.getLogger(name='dtlpy')
10
+
11
+
12
+ class ConsensusTaskType(str, Enum):
13
+ CONSENSUS = 'consensus'
14
+ QUALIFICATION = 'qualification'
15
+ HONEYPOT = 'honeypot'
16
+
17
+ class TaskPriority(int, Enum):
18
+ LOW = 1
19
+ MEDIUM = 2
20
+ HIGH = 3
21
+
22
+
23
+ class ItemAction:
24
+ def __init__(self, action, display_name=None, color='#FFFFFF', icon=None):
25
+ if not action or not isinstance(action, str):
26
+ raise ValueError('action should be a non-empty string')
27
+ self.action = action
28
+ if not display_name:
29
+ display_name = action
30
+ self.display_name = display_name
31
+ self.color = color
32
+ self.icon = icon
33
+
34
+ @classmethod
35
+ def from_json(cls, _json: dict):
36
+ kwarg = {
37
+ 'action': _json.get('action')
38
+ }
39
+
40
+ if _json.get('displayName', False):
41
+ kwarg['display_name'] = _json['displayName']
42
+
43
+ if _json.get('color', False):
44
+ kwarg['color'] = _json['color']
45
+
46
+ if _json.get('icon', False):
47
+ kwarg['icon'] = _json['icon']
48
+
49
+ return cls(**kwarg)
50
+
51
+ def to_json(self) -> dict:
52
+ _json = {
53
+ 'action': self.action,
54
+ 'color': self.color,
55
+ 'displayName': self.display_name if self.display_name is not None else self.action
56
+ }
57
+
58
+ if self.icon is not None:
59
+ _json['icon'] = self.icon
60
+
61
+ return _json
62
+
63
+
64
+ @attr.s
65
+ class Task:
66
+ """
67
+ Task object
68
+ """
69
+
70
+ # platform
71
+ name = attr.ib()
72
+ status = attr.ib()
73
+ project_id = attr.ib()
74
+ metadata = attr.ib(repr=False)
75
+ id = attr.ib()
76
+ url = attr.ib(repr=False)
77
+ task_owner = attr.ib(repr=False)
78
+ item_status = attr.ib(repr=False)
79
+ creator = attr.ib()
80
+ due_date = attr.ib()
81
+ dataset_id = attr.ib()
82
+ spec = attr.ib()
83
+ recipe_id = attr.ib(repr=False)
84
+ query = attr.ib(repr=False)
85
+ assignmentIds = attr.ib(repr=False)
86
+ annotation_status = attr.ib(repr=False)
87
+ progress = attr.ib()
88
+ for_review = attr.ib()
89
+ issues = attr.ib()
90
+ updated_at = attr.ib()
91
+ created_at = attr.ib()
92
+ available_actions = attr.ib()
93
+ total_items = attr.ib()
94
+ priority = attr.ib()
95
+ _description = attr.ib()
96
+
97
+ # sdk
98
+ _client_api = attr.ib(repr=False)
99
+ _current_assignments = attr.ib(default=None, repr=False)
100
+ _assignments = attr.ib(default=None, repr=False)
101
+ _project = attr.ib(default=None, repr=False)
102
+ _dataset = attr.ib(default=None, repr=False)
103
+ _tasks = attr.ib(default=None, repr=False)
104
+ _settings = attr.ib(default=None, repr=False)
105
+
106
+ @property
107
+ def description(self):
108
+ return self._description
109
+
110
+ @description.setter
111
+ def description(self, description):
112
+ if not isinstance(description, str):
113
+ raise ValueError('description should be a string')
114
+ if self._description is None:
115
+ self._description = {}
116
+ self._description['content'] = description
117
+
118
+ @staticmethod
119
+ def _protected_from_json(_json, client_api, project=None, dataset=None):
120
+ """
121
+ Same as from_json but with try-except to catch if error
122
+
123
+ :param dict _json: platform json that describe the task
124
+ :param client_api: ApiClient object
125
+ :param dtlpy.entities.project.Project project: project object where task will create
126
+ :param dtlpy.entities.dataset.Dataset dataset: dataset object that refer to the task
127
+ :return:
128
+ """
129
+ try:
130
+ task = Task.from_json(
131
+ _json=_json,
132
+ client_api=client_api,
133
+ project=project,
134
+ dataset=dataset
135
+ )
136
+ status = True
137
+ except Exception:
138
+ task = traceback.format_exc()
139
+ status = False
140
+ return status, task
141
+
142
+ @classmethod
143
+ def from_json(cls, _json, client_api, project=None, dataset=None):
144
+ """
145
+ Return the task object form the json
146
+
147
+ :param dict _json: platform json that describe the task
148
+ :param client_api: ApiClient object
149
+ :param dtlpy.entities.project.Project project: project object where task will create
150
+ :param dtlpy.entities.dataset.Dataset dataset: dataset object that refer to the task
151
+ :return:
152
+ """
153
+ if project is not None:
154
+ if project.id != _json.get('projectId', None):
155
+ logger.warning('Task has been fetched from a project that is not belong to it')
156
+ project = None
157
+
158
+ if dataset is not None:
159
+ if dataset.id != _json.get('datasetId', None):
160
+ logger.warning('Task has been fetched from a dataset that is not belong to it')
161
+ dataset = None
162
+
163
+ actions = [ItemAction.from_json(_json=action) for action in _json.get('availableActions', list())]
164
+
165
+ return cls(
166
+ name=_json.get('name', None),
167
+ status=_json.get('status', None),
168
+ project_id=_json.get('projectId', None),
169
+ metadata=_json.get('metadata', dict()),
170
+ url=_json.get('url', None),
171
+ spec=_json.get('spec', None),
172
+ id=_json['id'],
173
+ creator=_json.get('creator', None),
174
+ due_date=_json.get('dueDate', 0),
175
+ dataset_id=_json.get('datasetId', None),
176
+ recipe_id=_json.get('recipeId', None),
177
+ query=_json.get('query', None),
178
+ task_owner=_json.get('taskOwner', None),
179
+ item_status=_json.get('itemStatus', None),
180
+ assignmentIds=_json.get('assignmentIds', list()),
181
+ dataset=dataset,
182
+ project=project,
183
+ client_api=client_api,
184
+ annotation_status=_json.get('annotationStatus', None),
185
+ progress=_json.get('progress', None),
186
+ for_review=_json.get('forReview', None),
187
+ issues=_json.get('issues', None),
188
+ updated_at=_json.get('updatedAt', None),
189
+ created_at=_json.get('createdAt', None),
190
+ available_actions=actions,
191
+ total_items=_json.get('totalItems', None),
192
+ priority=_json.get('priority', None),
193
+ description=_json.get('description', None)
194
+ )
195
+
196
+ def to_json(self):
197
+ """
198
+ Returns platform _json format of object
199
+
200
+ :return: platform json format of object
201
+ :rtype: dict
202
+ """
203
+ _json = attr.asdict(
204
+ self, filter=attr.filters.exclude(
205
+ attr.fields(Task)._client_api,
206
+ attr.fields(Task)._project,
207
+ attr.fields(Task).project_id,
208
+ attr.fields(Task).dataset_id,
209
+ attr.fields(Task).recipe_id,
210
+ attr.fields(Task).task_owner,
211
+ attr.fields(Task).available_actions,
212
+ attr.fields(Task).item_status,
213
+ attr.fields(Task).due_date,
214
+ attr.fields(Task)._tasks,
215
+ attr.fields(Task)._dataset,
216
+ attr.fields(Task)._current_assignments,
217
+ attr.fields(Task)._assignments,
218
+ attr.fields(Task).annotation_status,
219
+ attr.fields(Task).for_review,
220
+ attr.fields(Task).issues,
221
+ attr.fields(Task).updated_at,
222
+ attr.fields(Task).created_at,
223
+ attr.fields(Task).total_items,
224
+ attr.fields(Task)._settings,
225
+ attr.fields(Task)._description
226
+ )
227
+ )
228
+ _json['projectId'] = self.project_id
229
+ _json['datasetId'] = self.dataset_id
230
+ _json['recipeId'] = self.recipe_id
231
+ _json['taskOwner'] = self.task_owner
232
+ _json['dueDate'] = self.due_date
233
+ _json['totalItems'] = self.total_items
234
+ _json['forReview'] = self.for_review
235
+ _json['description'] = self.description
236
+
237
+ if self.available_actions is not None:
238
+ _json['availableActions'] = [action.to_json() for action in self.available_actions]
239
+
240
+ return _json
241
+
242
+ @property
243
+ def platform_url(self):
244
+ return self._client_api._get_resource_url("projects/{}/tasks/{}".format(self.project.id, self.id))
245
+
246
+ @property
247
+ def current_assignments(self):
248
+ if self._current_assignments is None:
249
+ self._current_assignments = list()
250
+ for assignment in self.assignmentIds:
251
+ self._current_assignments.append(self.assignments.get(assignment_id=assignment))
252
+ return self._current_assignments
253
+
254
+ @property
255
+ def assignments(self):
256
+ if self._assignments is None:
257
+ self._assignments = repositories.Assignments(client_api=self._client_api, dataset=self._dataset,
258
+ project=self.project, task=self, project_id=self.project_id)
259
+ assert isinstance(self._assignments, repositories.Assignments)
260
+ return self._assignments
261
+
262
+ @property
263
+ def tasks(self):
264
+ if self._tasks is None:
265
+ self._tasks = repositories.Tasks(client_api=self._client_api, project=self.project, dataset=self.dataset)
266
+ assert isinstance(self._tasks, repositories.Tasks)
267
+ return self._tasks
268
+
269
+ @property
270
+ def settings(self):
271
+ if self._settings is None:
272
+ self._settings = repositories.Settings(
273
+ client_api=self._client_api,
274
+ project=self.project,
275
+ dataset=self.dataset,
276
+ task=self
277
+ )
278
+ assert isinstance(self._settings, repositories.Settings)
279
+ return self._settings
280
+
281
+ @property
282
+ def project(self):
283
+ if self._project is None:
284
+ self.get_project()
285
+ if self._project is None:
286
+ raise exceptions.PlatformException(error='2001',
287
+ message='Missing entity "project". need to "get_project()" ')
288
+ assert isinstance(self._project, entities.Project)
289
+ return self._project
290
+
291
+ @property
292
+ def dataset(self):
293
+ if self._dataset is None:
294
+ self.get_dataset()
295
+ if self._dataset is None:
296
+ raise exceptions.PlatformException(error='2001',
297
+ message='Missing entity "dataset". need to "get_dataset()" ')
298
+ assert isinstance(self._dataset, entities.Dataset)
299
+ return self._dataset
300
+
301
+ def get_project(self):
302
+ if self._project is None:
303
+ self._project = repositories.Projects(client_api=self._client_api).get(project_id=self.project_id)
304
+
305
+ def get_dataset(self):
306
+ if self._dataset is None:
307
+ self._dataset = repositories.Datasets(client_api=self._client_api, project=self._project).get(
308
+ dataset_id=self.dataset_id)
309
+
310
+ def open_in_web(self):
311
+ """
312
+ Open the task in web platform
313
+
314
+ :return:
315
+ """
316
+ self._client_api._open_in_web(url=self.platform_url)
317
+
318
+ def delete(self, wait=True):
319
+ """
320
+ Delete task from platform
321
+
322
+ :param bool wait: wait until delete task finish
323
+ :return: True
324
+ :rtype: bool
325
+ """
326
+ return self.tasks.delete(task_id=self.id, wait=wait)
327
+
328
+ def update(self, system_metadata=False):
329
+ """
330
+ Update an Annotation Task
331
+
332
+ :param bool system_metadata: DEPRECATED
333
+ """
334
+ return self.tasks.update(task=self, system_metadata=system_metadata)
335
+
336
+ def create_qa_task(self,
337
+ due_date,
338
+ assignee_ids,
339
+ filters=None,
340
+ items=None,
341
+ query=None,
342
+ workload=None,
343
+ metadata=None,
344
+ available_actions=None,
345
+ wait=True,
346
+ batch_size=None,
347
+ max_batch_workload=None,
348
+ allowed_assignees=None,
349
+ priority=TaskPriority.MEDIUM
350
+ ):
351
+ """
352
+ Create a new QA Task
353
+
354
+ :param float due_date: date by which the QA task should be finished; for example, due_date=datetime.datetime(day=1, month=1, year=2029).timestamp()
355
+ :param list assignee_ids: list the QA task assignees (contributors) that should be working on the task. Provide a list of users' emails
356
+ :param entities.Filters filters: dl.Filters entity to filter items for the task
357
+ :param List[entities.Item] items: list of items (item Id or objects) to insert to the task
358
+ :param dict DQL query: filter items for the task
359
+ :param List[WorkloadUnit] workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]
360
+ :param dict metadata: metadata for the task
361
+ :param list available_actions: list of available actions (statuses) that will be available for the task items; The default statuses are: "approved" and "discard"
362
+ :param bool wait: wait until create task finish
363
+ :param int batch_size: Pulling batch size (items), use with pulling allocation method. Restrictions - Min 3, max 100
364
+ :param int max_batch_workload: Max items in assignment, use with pulling allocation method. Restrictions - Min batchSize + 2, max batchSize * 2
365
+ :param list allowed_assignees: list the task assignees (contributors) that should be working on the task. Provide a list of users' emails
366
+ :param entities.TaskPriority priority: priority of the task options in entities.TaskPriority
367
+ :return: task object
368
+ :rtype: dtlpy.entities.task.Task
369
+
370
+ **Example**:
371
+
372
+ .. code-block:: python
373
+
374
+ task = task.create_qa_task(due_date = datetime.datetime(day= 1, month= 1, year= 2029).timestamp(),
375
+ assignee_ids =[ 'annotator1@dataloop.ai', 'annotator2@dataloop.ai'])
376
+ """
377
+ return self.tasks.create_qa_task(task=self,
378
+ due_date=due_date,
379
+ assignee_ids=assignee_ids,
380
+ filters=filters,
381
+ items=items,
382
+ query=query,
383
+ workload=workload,
384
+ metadata=metadata,
385
+ available_actions=available_actions,
386
+ wait=wait,
387
+ batch_size=batch_size,
388
+ max_batch_workload=max_batch_workload,
389
+ allowed_assignees=allowed_assignees,
390
+ priority=priority
391
+ )
392
+
393
+ def create_assignment(self, assignment_name, assignee_id, items=None, filters=None):
394
+ """
395
+ Create a new assignment
396
+
397
+ :param str assignment_name: assignment name
398
+ :param str assignee_id: the assignment assignees (contributors) that should be working on the task. Provide a user email
399
+ :param List[entities.Item] items: list of items (item Id or objects) to insert to the task
400
+ :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
401
+ :return: Assignment object
402
+ :rtype: dtlpy.entities.assignment.Assignment assignment
403
+
404
+ **Example**:
405
+
406
+ .. code-block:: python
407
+
408
+ assignment = task.create_assignment(assignee_id='annotator1@dataloop.ai')
409
+ """
410
+ assignment = self.assignments.create(assignee_id=assignee_id,
411
+ filters=filters,
412
+ items=items)
413
+
414
+ assignment.metadata['system']['taskId'] = self.id
415
+ assignment.update(system_metadata=True)
416
+ self.assignmentIds.append(assignment.id)
417
+ self.update()
418
+ self.add_items(filters=filters, items=items)
419
+ return assignment
420
+
421
+ def add_items(self, filters=None, items=None, assignee_ids=None, workload=None, limit=None, wait=True, query=None):
422
+ """
423
+ Add items to Task
424
+
425
+ :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
426
+ :param list items: list of items (item Ids or objects) to add to the task
427
+ :param list assignee_ids: list to assignee who works in the task
428
+ :param list workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]
429
+ :param int limit: the limit items that task can include
430
+ :param bool wait: wait until add items will to finish
431
+ :param dict query: query to filter the items for the task
432
+
433
+ :return: task entity
434
+ :rtype: dtlpy.entities.task.Task
435
+ """
436
+ return self.tasks.add_items(task=self,
437
+ filters=filters,
438
+ items=items,
439
+ assignee_ids=assignee_ids,
440
+ workload=workload,
441
+ limit=limit,
442
+ wait=wait,
443
+ query=query)
444
+
445
+ def remove_items(self,
446
+ filters: entities.Filters = None,
447
+ query=None,
448
+ items=None,
449
+ wait=True):
450
+ """
451
+ remove items from Task.
452
+
453
+ **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned to be *owner* of the annotation task.
454
+
455
+ :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
456
+ :param dict query: query to filter the items use it
457
+ :param list items: list of items to add to the task
458
+ :param bool wait: wait until remove items finish
459
+
460
+ :return: True if success and an error if failed
461
+ :rtype: bool
462
+ """
463
+ return self.tasks.remove_items(task=self,
464
+ query=query,
465
+ filters=filters,
466
+ items=items,
467
+ wait=wait)
468
+
469
+ def get_items(self, filters=None, get_consensus_items: bool = False):
470
+ """
471
+ Get the task items
472
+
473
+ :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters
474
+ :return: list of the items or PagedEntity output of items
475
+ :rtype: list or dtlpy.entities.paged_entities.PagedEntities
476
+ """
477
+ return self.tasks.get_items(task_id=self.id, dataset=self.dataset, filters=filters, get_consensus_items=get_consensus_items)
478
+
479
+ def set_status(self, status: str, operation: str, item_ids: List[str]):
480
+ """
481
+ Update item status within task
482
+
483
+ :param str status: string the describes the status
484
+ :param str operation: the status action need 'create' or 'delete'
485
+ :param list item_ids: List[str] id items ids
486
+
487
+ :return: True if success
488
+ :rtype: bool
489
+ """
490
+ return self.tasks.set_status(status=status, operation=operation, item_ids=item_ids, task_id=self.id)
491
+