Elements Worker¶
arkindex_worker.worker ¶
Base classes to implement Arkindex workers.
Classes¶
ActivityState ¶
Bases: Enum
Processing state of an element.
Attributes¶
Queued
class-attribute
instance-attribute
¶
Queued = 'queued'
The element has not yet been processed by a worker.
Started
class-attribute
instance-attribute
¶
Started = 'started'
The element is being processed by a worker.
Processed
class-attribute
instance-attribute
¶
Processed = 'processed'
The element has been successfully processed by a worker.
Error
class-attribute
instance-attribute
¶
Error = 'error'
An error occurred while processing this element.
ElementsWorker ¶
ElementsWorker(
description="Arkindex Elements Worker",
support_cache=False,
)
Bases: BaseWorker
, ClassificationMixin
, ElementMixin
, TranscriptionMixin
, WorkerVersionMixin
, EntityMixin
, MetaDataMixin
Base class for ML workers that operate on Arkindex elements.
This class inherits from numerous mixin classes found in other modules of
arkindex.worker
, which provide helpers to read and write to the Arkindex API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
description |
str
|
The worker’s description |
'Arkindex Elements Worker'
|
support_cache |
bool
|
Whether the worker supports cache |
False
|
Source code in arkindex_worker/worker/__init__.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
|
Attributes¶
entity_types
instance-attribute
¶
entity_types = {}
Known and available entity types in processed corpus
store_activity
property
¶
store_activity: bool
Whether or not WorkerActivity support has been enabled on the DataImport used to run this worker.
Functions¶
list_elements ¶
list_elements()
List the elements to be processed, either from the CLI arguments or the cache database when enabled.
Returns:
Type | Description |
---|---|
Union[Iterable[CachedElement], List[str]]
|
An iterable of CachedElement when cache support is enabled, and a list of strings representing element IDs otherwise. |
Source code in arkindex_worker/worker/__init__.py
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
|
configure ¶
configure()
Setup the worker using CLI arguments and environment variables.
Source code in arkindex_worker/worker/__init__.py
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
|
run ¶
run()
Implements an Arkindex worker that goes through each element returned by list_elements. It calls process_element, catching exceptions and reporting them using the Reporter, and handles saving the report once the process is complete as well as WorkerActivity updates when enabled.
Source code in arkindex_worker/worker/__init__.py
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
|
process_element ¶
process_element(element)
Override this method to implement your worker and process a single Arkindex element at once.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to process. Will be a CachedElement instance if cache support is enabled, and an Element instance otherwise. |
required |
Source code in arkindex_worker/worker/__init__.py
249 250 251 252 253 254 255 256 |
|
update_activity ¶
update_activity(element_id, state)
Update the WorkerActivity for this element and worker.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element_id |
Union[str, uuid.UUID]
|
ID of the element. |
required |
state |
ActivityState
|
New WorkerActivity state for this element. |
required |
Returns:
Type | Description |
---|---|
bool
|
True if the update has been successful or WorkerActivity support is disabled. False if the update has failed due to a conflict; this worker might have already processed this element. |
Source code in arkindex_worker/worker/__init__.py
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
|