"""
tasks service
Provides a management API for tasks in the system.
"""
import enum
from datetime import datetime
import six
from dateutil.parser import parse as parse_datetime
from ....backend_api.session import Request, BatchRequest, Response, NonStrictDataModel, schema_property, StringEnum
class MultiFieldPatternData(NonStrictDataModel):
"""
:param pattern: Pattern string (regex)
:type pattern: str
:param fields: List of field names
:type fields: Sequence[str]
"""
_schema = {
'properties': {
'fields': {
'description': 'List of field names',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'pattern': {
'description': 'Pattern string (regex)',
'type': ['string', 'null'],
},
},
'type': 'object',
}
def __init__(
self, pattern=None, fields=None, **kwargs):
super(MultiFieldPatternData, self).__init__(**kwargs)
self.pattern = pattern
self.fields = fields
@schema_property('pattern')
def pattern(self):
return self._property_pattern
@pattern.setter
def pattern(self, value):
if value is None:
self._property_pattern = None
return
self.assert_isinstance(value, "pattern", six.string_types)
self._property_pattern = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (list, tuple))
self.assert_isinstance(value, "fields", six.string_types, is_array=True)
self._property_fields = value
class Script(NonStrictDataModel):
"""
:param binary: Binary to use when running the script
:type binary: str
:param repository: Name of the repository where the script is located
:type repository: str
:param tag: Repository tag
:type tag: str
:param branch: Repository branch id If not provided and tag not provided,
default repository branch is used.
:type branch: str
:param version_num: Version (changeset) number. Optional (default is head
version) Unused if tag is provided.
:type version_num: str
:param entry_point: Path to execute within the repository
:type entry_point: str
:param working_dir: Path to the folder from which to run the script Default -
root folder of repository
:type working_dir: str
:param requirements: A JSON object containing requirements strings by key
:type requirements: dict
:param diff: Uncommitted changes found in the repository when task was run
:type diff: str
"""
_schema = {
'properties': {
'binary': {
'default': 'python',
'description': 'Binary to use when running the script',
'type': ['string', 'null'],
},
'branch': {
'description': 'Repository branch id If not provided and tag not provided, default repository branch is used.',
'type': ['string', 'null'],
},
'diff': {
'description': 'Uncommitted changes found in the repository when task was run',
'type': ['string', 'null'],
},
'entry_point': {
'description': 'Path to execute within the repository',
'type': ['string', 'null'],
},
'repository': {
'description': 'Name of the repository where the script is located',
'type': ['string', 'null'],
},
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': ['object', 'null'],
},
'tag': {'description': 'Repository tag', 'type': ['string', 'null']},
'version_num': {
'description': 'Version (changeset) number. Optional (default is head version) Unused if tag is provided.',
'type': ['string', 'null'],
},
'working_dir': {
'description': 'Path to the folder from which to run the script Default - root folder of repository',
'type': ['string', 'null'],
},
},
'type': 'object',
}
def __init__(
self, binary="python", repository=None, tag=None, branch=None, version_num=None, entry_point=None, working_dir=None, requirements=None, diff=None, **kwargs):
super(Script, self).__init__(**kwargs)
self.binary = binary
self.repository = repository
self.tag = tag
self.branch = branch
self.version_num = version_num
self.entry_point = entry_point
self.working_dir = working_dir
self.requirements = requirements
self.diff = diff
@schema_property('binary')
def binary(self):
return self._property_binary
@binary.setter
def binary(self, value):
if value is None:
self._property_binary = None
return
self.assert_isinstance(value, "binary", six.string_types)
self._property_binary = value
@schema_property('repository')
def repository(self):
return self._property_repository
@repository.setter
def repository(self, value):
if value is None:
self._property_repository = None
return
self.assert_isinstance(value, "repository", six.string_types)
self._property_repository = value
@schema_property('tag')
def tag(self):
return self._property_tag
@tag.setter
def tag(self, value):
if value is None:
self._property_tag = None
return
self.assert_isinstance(value, "tag", six.string_types)
self._property_tag = value
@schema_property('branch')
def branch(self):
return self._property_branch
@branch.setter
def branch(self, value):
if value is None:
self._property_branch = None
return
self.assert_isinstance(value, "branch", six.string_types)
self._property_branch = value
@schema_property('version_num')
def version_num(self):
return self._property_version_num
@version_num.setter
def version_num(self, value):
if value is None:
self._property_version_num = None
return
self.assert_isinstance(value, "version_num", six.string_types)
self._property_version_num = value
@schema_property('entry_point')
def entry_point(self):
return self._property_entry_point
@entry_point.setter
def entry_point(self, value):
if value is None:
self._property_entry_point = None
return
self.assert_isinstance(value, "entry_point", six.string_types)
self._property_entry_point = value
@schema_property('working_dir')
def working_dir(self):
return self._property_working_dir
@working_dir.setter
def working_dir(self, value):
if value is None:
self._property_working_dir = None
return
self.assert_isinstance(value, "working_dir", six.string_types)
self._property_working_dir = value
@schema_property('requirements')
def requirements(self):
return self._property_requirements
@requirements.setter
def requirements(self, value):
if value is None:
self._property_requirements = None
return
self.assert_isinstance(value, "requirements", (dict,))
self._property_requirements = value
@schema_property('diff')
def diff(self):
return self._property_diff
@diff.setter
def diff(self, value):
if value is None:
self._property_diff = None
return
self.assert_isinstance(value, "diff", six.string_types)
self._property_diff = value
class Output(NonStrictDataModel):
"""
:param destination: Storage id. This is where output files will be stored.
:type destination: str
:param model: Model id.
:type model: str
:param result: Task result. Values: 'success', 'failure'
:type result: str
:param error: Last error text
:type error: str
"""
_schema = {
'properties': {
'destination': {
'description': 'Storage id. This is where output files will be stored.',
'type': ['string', 'null'],
},
'error': {'description': 'Last error text', 'type': ['string', 'null']},
'model': {'description': 'Model id.', 'type': ['string', 'null']},
'result': {
'description': "Task result. Values: 'success', 'failure'",
'type': ['string', 'null'],
},
},
'type': 'object',
}
def __init__(
self, destination=None, model=None, result=None, error=None, **kwargs):
super(Output, self).__init__(**kwargs)
self.destination = destination
self.model = model
self.result = result
self.error = error
@schema_property('destination')
def destination(self):
return self._property_destination
@destination.setter
def destination(self, value):
if value is None:
self._property_destination = None
return
self.assert_isinstance(value, "destination", six.string_types)
self._property_destination = value
@schema_property('model')
def model(self):
return self._property_model
@model.setter
def model(self, value):
if value is None:
self._property_model = None
return
self.assert_isinstance(value, "model", six.string_types)
self._property_model = value
@schema_property('result')
def result(self):
return self._property_result
@result.setter
def result(self, value):
if value is None:
self._property_result = None
return
self.assert_isinstance(value, "result", six.string_types)
self._property_result = value
@schema_property('error')
def error(self):
return self._property_error
@error.setter
def error(self, value):
if value is None:
self._property_error = None
return
self.assert_isinstance(value, "error", six.string_types)
self._property_error = value
class Execution(NonStrictDataModel):
"""
:param parameters: Json object containing the Task parameters
:type parameters: dict
:param model: Execution input model ID Not applicable for Register (Import)
tasks
:type model: str
:param model_desc: Json object representing the Model descriptors
:type model_desc: dict
:param model_labels: Json object representing the ids of the labels in the
model. The keys are the layers' names and the values are the IDs. Not
applicable for Register (Import) tasks. Mandatory for Training tasks
:type model_labels: dict
:param framework: Framework related to the task. Case insensitive. Mandatory
for Training tasks.
:type framework: str
"""
_schema = {
'properties': {
'framework': {
'description': 'Framework related to the task. Case insensitive. Mandatory for Training tasks. ',
'type': ['string', 'null'],
},
'model': {
'description': 'Execution input model ID Not applicable for Register (Import) tasks',
'type': ['string', 'null'],
},
'model_desc': {
'additionalProperties': True,
'description': 'Json object representing the Model descriptors',
'type': ['object', 'null'],
},
'model_labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model.\n The keys are the layers' names and the values are the IDs.\n Not applicable for Register (Import) tasks.\n Mandatory for Training tasks",
'type': ['object', 'null'],
},
'parameters': {
'additionalProperties': True,
'description': 'Json object containing the Task parameters',
'type': ['object', 'null'],
},
},
'type': 'object',
}
def __init__(
self, parameters=None, model=None, model_desc=None, model_labels=None, framework=None, **kwargs):
super(Execution, self).__init__(**kwargs)
self.parameters = parameters
self.model = model
self.model_desc = model_desc
self.model_labels = model_labels
self.framework = framework
@schema_property('parameters')
def parameters(self):
return self._property_parameters
@parameters.setter
def parameters(self, value):
if value is None:
self._property_parameters = None
return
self.assert_isinstance(value, "parameters", (dict,))
self._property_parameters = value
@schema_property('model')
def model(self):
return self._property_model
@model.setter
def model(self, value):
if value is None:
self._property_model = None
return
self.assert_isinstance(value, "model", six.string_types)
self._property_model = value
@schema_property('model_desc')
def model_desc(self):
return self._property_model_desc
@model_desc.setter
def model_desc(self, value):
if value is None:
self._property_model_desc = None
return
self.assert_isinstance(value, "model_desc", (dict,))
self._property_model_desc = value
@schema_property('model_labels')
def model_labels(self):
return self._property_model_labels
@model_labels.setter
def model_labels(self, value):
if value is None:
self._property_model_labels = None
return
self.assert_isinstance(value, "model_labels", (dict,))
self._property_model_labels = value
@schema_property('framework')
def framework(self):
return self._property_framework
@framework.setter
def framework(self, value):
if value is None:
self._property_framework = None
return
self.assert_isinstance(value, "framework", six.string_types)
self._property_framework = value
class TaskStatusEnum(StringEnum):
created = "created"
queued = "queued"
in_progress = "in_progress"
stopped = "stopped"
completed = "completed"
published = "published"
publishing = "publishing"
closed = "closed"
failed = "failed"
unknown = "unknown"
class TaskTypeEnum(StringEnum):
training = "training"
testing = "testing"
class LastMetricsEvent(NonStrictDataModel):
"""
:param metric: Metric name
:type metric: str
:param variant: Variant name
:type variant: str
:param type: Event type
:type type: str
:param timestamp: Event report time (UTC)
:type timestamp: datetime.datetime
:param iter: Iteration number
:type iter: int
:param value: Value
:type value: float
"""
_schema = {
'properties': {
'iter': {
'description': 'Iteration number',
'type': ['integer', 'null'],
},
'metric': {'description': 'Metric name', 'type': ['string', 'null']},
'timestamp': {
'description': 'Event report time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'type': {'description': 'Event type', 'type': ['string', 'null']},
'value': {'description': 'Value', 'type': ['number', 'null']},
'variant': {'description': 'Variant name', 'type': ['string', 'null']},
},
'type': 'object',
}
def __init__(
self, metric=None, variant=None, type=None, timestamp=None, iter=None, value=None, **kwargs):
super(LastMetricsEvent, self).__init__(**kwargs)
self.metric = metric
self.variant = variant
self.type = type
self.timestamp = timestamp
self.iter = iter
self.value = value
@schema_property('metric')
def metric(self):
return self._property_metric
@metric.setter
def metric(self, value):
if value is None:
self._property_metric = None
return
self.assert_isinstance(value, "metric", six.string_types)
self._property_metric = value
@schema_property('variant')
def variant(self):
return self._property_variant
@variant.setter
def variant(self, value):
if value is None:
self._property_variant = None
return
self.assert_isinstance(value, "variant", six.string_types)
self._property_variant = value
@schema_property('type')
def type(self):
return self._property_type
@type.setter
def type(self, value):
if value is None:
self._property_type = None
return
self.assert_isinstance(value, "type", six.string_types)
self._property_type = value
@schema_property('timestamp')
def timestamp(self):
return self._property_timestamp
@timestamp.setter
def timestamp(self, value):
if value is None:
self._property_timestamp = None
return
self.assert_isinstance(value, "timestamp", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_timestamp = value
@schema_property('iter')
def iter(self):
return self._property_iter
@iter.setter
def iter(self, value):
if value is None:
self._property_iter = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "iter", six.integer_types)
self._property_iter = value
@schema_property('value')
def value(self):
return self._property_value
@value.setter
def value(self, value):
if value is None:
self._property_value = None
return
self.assert_isinstance(value, "value", six.integer_types + (float,))
self._property_value = value
class LastMetricsVariants(NonStrictDataModel):
"""
Last metric events, one for each variant hash
"""
_schema = {
'additionalProperties': {'$ref': '#/definitions/last_metrics_event'},
'description': 'Last metric events, one for each variant hash',
'type': 'object',
}
class Task(NonStrictDataModel):
"""
:param id: Task id
:type id: str
:param name: Task Name
:type name: str
:param user: Associated user id
:type user: str
:param company: Company ID
:type company: str
:param type: Type of task. Values: 'training', 'testing'
:type type: TaskTypeEnum
:param status:
:type status: TaskStatusEnum
:param comment: Free text comment
:type comment: str
:param created: Task creation time (UTC)
:type created: datetime.datetime
:param started: Task start time (UTC)
:type started: datetime.datetime
:param completed: Task end time (UTC)
:type completed: datetime.datetime
:param parent: Parent task id
:type parent: str
:param project: Project ID of the project to which this task is assigned
:type project: str
:param output: Task output params
:type output: Output
:param execution: Task execution params
:type execution: Execution
:param script: Script info
:type script: Script
:param tags: Tags list
:type tags: Sequence[str]
:param status_changed: Last status change time
:type status_changed: datetime.datetime
:param status_message: free text string representing info about the status
:type status_message: str
:param status_reason: Reason for last status change
:type status_reason: str
:param published: Last status change time
:type published: datetime.datetime
:param last_update: Last time this task was created, updated, changed or events
for this task were reported
:type last_update: datetime.datetime
:param last_iteration: Last iteration reported for this task
:type last_iteration: int
:param last_metrics: Last metric variants (hash to events), one for each metric
hash
:type last_metrics: dict
"""
_schema = {
'properties': {
'comment': {
'description': 'Free text comment',
'type': ['string', 'null'],
},
'company': {'description': 'Company ID', 'type': ['string', 'null']},
'completed': {
'description': 'Task end time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'created': {
'description': 'Task creation time (UTC) ',
'format': 'date-time',
'type': ['string', 'null'],
},
'execution': {
'description': 'Task execution params',
'oneOf': [{'$ref': '#/definitions/execution'}, {'type': 'null'}],
},
'id': {'description': 'Task id', 'type': ['string', 'null']},
'last_iteration': {
'description': 'Last iteration reported for this task',
'type': ['integer', 'null'],
},
'last_metrics': {
'additionalProperties': {
'$ref': '#/definitions/last_metrics_variants',
},
'description': 'Last metric variants (hash to events), one for each metric hash',
'type': ['object', 'null'],
},
'last_update': {
'description': 'Last time this task was created, updated, changed or events for this task were reported',
'format': 'date-time',
'type': ['string', 'null'],
},
'name': {'description': 'Task Name', 'type': ['string', 'null']},
'output': {
'description': 'Task output params',
'oneOf': [{'$ref': '#/definitions/output'}, {'type': 'null'}],
},
'parent': {'description': 'Parent task id', 'type': ['string', 'null']},
'project': {
'description': 'Project ID of the project to which this task is assigned',
'type': ['string', 'null'],
},
'published': {
'description': 'Last status change time',
'format': 'date-time',
'type': ['string', 'null'],
},
'script': {
'description': 'Script info',
'oneOf': [{'$ref': '#/definitions/script'}, {'type': 'null'}],
},
'started': {
'description': 'Task start time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'status': {
'description': '',
'oneOf': [
{'$ref': '#/definitions/task_status_enum'},
{'type': 'null'},
],
},
'status_changed': {
'description': 'Last status change time',
'format': 'date-time',
'type': ['string', 'null'],
},
'status_message': {
'description': 'free text string representing info about the status',
'type': ['string', 'null'],
},
'status_reason': {
'description': 'Reason for last status change',
'type': ['string', 'null'],
},
'tags': {
'description': 'Tags list',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'type': {
'description': "Type of task. Values: 'training', 'testing'",
'oneOf': [
{'$ref': '#/definitions/task_type_enum'},
{'type': 'null'},
],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
}
def __init__(
self, id=None, name=None, user=None, company=None, type=None, status=None, comment=None, created=None, started=None, completed=None, parent=None, project=None, output=None, execution=None, script=None, tags=None, status_changed=None, status_message=None, status_reason=None, published=None, last_update=None, last_iteration=None, last_metrics=None, **kwargs):
super(Task, self).__init__(**kwargs)
self.id = id
self.name = name
self.user = user
self.company = company
self.type = type
self.status = status
self.comment = comment
self.created = created
self.started = started
self.completed = completed
self.parent = parent
self.project = project
self.output = output
self.execution = execution
self.script = script
self.tags = tags
self.status_changed = status_changed
self.status_message = status_message
self.status_reason = status_reason
self.published = published
self.last_update = last_update
self.last_iteration = last_iteration
self.last_metrics = last_metrics
@schema_property('id')
def id(self):
return self._property_id
@id.setter
def id(self, value):
if value is None:
self._property_id = None
return
self.assert_isinstance(value, "id", six.string_types)
self._property_id = value
@schema_property('name')
def name(self):
return self._property_name
@name.setter
def name(self, value):
if value is None:
self._property_name = None
return
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('user')
def user(self):
return self._property_user
@user.setter
def user(self, value):
if value is None:
self._property_user = None
return
self.assert_isinstance(value, "user", six.string_types)
self._property_user = value
@schema_property('company')
def company(self):
return self._property_company
@company.setter
def company(self, value):
if value is None:
self._property_company = None
return
self.assert_isinstance(value, "company", six.string_types)
self._property_company = value
@schema_property('type')
def type(self):
return self._property_type
@type.setter
def type(self, value):
if value is None:
self._property_type = None
return
if isinstance(value, six.string_types):
try:
value = TaskTypeEnum(value)
except ValueError:
pass
else:
self.assert_isinstance(value, "type", enum.Enum)
self._property_type = value
@schema_property('status')
def status(self):
return self._property_status
@status.setter
def status(self, value):
if value is None:
self._property_status = None
return
if isinstance(value, six.string_types):
try:
value = TaskStatusEnum(value)
except ValueError:
pass
else:
self.assert_isinstance(value, "status", enum.Enum)
self._property_status = value
@schema_property('comment')
def comment(self):
return self._property_comment
@comment.setter
def comment(self, value):
if value is None:
self._property_comment = None
return
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = value
@schema_property('created')
def created(self):
return self._property_created
@created.setter
def created(self, value):
if value is None:
self._property_created = None
return
self.assert_isinstance(value, "created", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_created = value
@schema_property('started')
def started(self):
return self._property_started
@started.setter
def started(self, value):
if value is None:
self._property_started = None
return
self.assert_isinstance(value, "started", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_started = value
@schema_property('completed')
def completed(self):
return self._property_completed
@completed.setter
def completed(self, value):
if value is None:
self._property_completed = None
return
self.assert_isinstance(value, "completed", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_completed = value
@schema_property('parent')
def parent(self):
return self._property_parent
@parent.setter
def parent(self, value):
if value is None:
self._property_parent = None
return
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = value
@schema_property('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
self.assert_isinstance(value, "project", six.string_types)
self._property_project = value
@schema_property('output')
def output(self):
return self._property_output
@output.setter
def output(self, value):
if value is None:
self._property_output = None
return
if isinstance(value, dict):
value = Output.from_dict(value)
else:
self.assert_isinstance(value, "output", Output)
self._property_output = value
@schema_property('execution')
def execution(self):
return self._property_execution
@execution.setter
def execution(self, value):
if value is None:
self._property_execution = None
return
if isinstance(value, dict):
value = Execution.from_dict(value)
else:
self.assert_isinstance(value, "execution", Execution)
self._property_execution = value
@schema_property('script')
def script(self):
return self._property_script
@script.setter
def script(self, value):
if value is None:
self._property_script = None
return
if isinstance(value, dict):
value = Script.from_dict(value)
else:
self.assert_isinstance(value, "script", Script)
self._property_script = value
@schema_property('tags')
def tags(self):
return self._property_tags
@tags.setter
def tags(self, value):
if value is None:
self._property_tags = None
return
self.assert_isinstance(value, "tags", (list, tuple))
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('status_changed')
def status_changed(self):
return self._property_status_changed
@status_changed.setter
def status_changed(self, value):
if value is None:
self._property_status_changed = None
return
self.assert_isinstance(value, "status_changed", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_status_changed = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('published')
def published(self):
return self._property_published
@published.setter
def published(self, value):
if value is None:
self._property_published = None
return
self.assert_isinstance(value, "published", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_published = value
@schema_property('last_update')
def last_update(self):
return self._property_last_update
@last_update.setter
def last_update(self, value):
if value is None:
self._property_last_update = None
return
self.assert_isinstance(value, "last_update", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_last_update = value
@schema_property('last_iteration')
def last_iteration(self):
return self._property_last_iteration
@last_iteration.setter
def last_iteration(self, value):
if value is None:
self._property_last_iteration = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "last_iteration", six.integer_types)
self._property_last_iteration = value
@schema_property('last_metrics')
def last_metrics(self):
return self._property_last_metrics
@last_metrics.setter
def last_metrics(self, value):
if value is None:
self._property_last_metrics = None
return
self.assert_isinstance(value, "last_metrics", (dict,))
self._property_last_metrics = value
class CloseRequest(Request):
"""
Indicates that task is closed
:param force: Allows forcing state change even if transition is not supported
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "close"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': 'Allows forcing state change even if transition is not supported',
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(CloseRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class CloseResponse(Response):
"""
Response of tasks.close endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "close"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(CloseResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class CompletedRequest(Request):
"""
Signal a task has completed
:param force: If not true, call fails if the task status is not
created/in_progress/published
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "completed"
_version = "2.2"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': 'If not true, call fails if the task status is not created/in_progress/published',
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(CompletedRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class CompletedResponse(Response):
"""
Response of tasks.completed endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "completed"
_version = "2.2"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(CompletedResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class CreateRequest(Request):
"""
Create a new task
:param name: Task name. Unique within the company.
:type name: str
:param tags: Tags list
:type tags: Sequence[str]
:param type: Type of task
:type type: TaskTypeEnum
:param comment: Free text comment
:type comment: str
:param parent: Parent task id Must be a completed task.
:type parent: str
:param project: Project ID of the project to which this task is assigned Must
exist[ab]
:type project: str
:param input: Task input params. (input view must be provided).
:type input: Input
:param output_dest: Output storage id Must be a reference to an existing
storage.
:type output_dest: str
:param execution: Task execution params
:type execution: Execution
:param script: Script info
:type script: Script
"""
_service = "tasks"
_action = "create"
_version = "1.9"
_schema = {
'definitions': {
'execution': {
'properties': {
'framework': {
'description': 'Framework related to the task. Case insensitive. Mandatory for Training tasks. ',
'type': ['string', 'null'],
},
'model': {
'description': 'Execution input model ID Not applicable for Register (Import) tasks',
'type': ['string', 'null'],
},
'model_desc': {
'additionalProperties': True,
'description': 'Json object representing the Model descriptors',
'type': ['object', 'null'],
},
'model_labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model.\n The keys are the layers' names and the values are the IDs.\n Not applicable for Register (Import) tasks.\n Mandatory for Training tasks",
'type': ['object', 'null'],
},
'parameters': {
'additionalProperties': True,
'description': 'Json object containing the Task parameters',
'type': ['object', 'null'],
},
},
'type': 'object',
},
'script': {
'properties': {
'binary': {
'default': 'python',
'description': 'Binary to use when running the script',
'type': ['string', 'null'],
},
'branch': {
'description': 'Repository branch id If not provided and tag not provided, default repository branch is used.',
'type': ['string', 'null'],
},
'diff': {
'description': 'Uncommitted changes found in the repository when task was run',
'type': ['string', 'null'],
},
'entry_point': {
'description': 'Path to execute within the repository',
'type': ['string', 'null'],
},
'repository': {
'description': 'Name of the repository where the script is located',
'type': ['string', 'null'],
},
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': ['object', 'null'],
},
'tag': {
'description': 'Repository tag',
'type': ['string', 'null'],
},
'version_num': {
'description': 'Version (changeset) number. Optional (default is head version) Unused if tag is provided.',
'type': ['string', 'null'],
},
'working_dir': {
'description': 'Path to the folder from which to run the script Default - root folder of repository',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task_type_enum': {'enum': ['training', 'testing'], 'type': 'string'},
},
'properties': {
'comment': {'description': 'Free text comment ', 'type': 'string'},
'execution': {
'$ref': '#/definitions/execution',
'description': 'Task execution params',
},
'input': {
# '$ref': '#/definitions/input',
'description': 'Task input params. (input view must be provided).',
},
'name': {
'description': 'Task name. Unique within the company.',
'type': 'string',
},
'output_dest': {
'description': 'Output storage id Must be a reference to an existing storage.',
'type': 'string',
},
'parent': {
'description': 'Parent task id Must be a completed task.',
'type': 'string',
},
'project': {
'description': 'Project ID of the project to which this task is assigned Must exist[ab]',
'type': 'string',
},
'script': {
'$ref': '#/definitions/script',
'description': 'Script info',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'type': {
'$ref': '#/definitions/task_type_enum',
'description': 'Type of task',
},
},
'required': ['name', 'type'],
'type': 'object',
}
def __init__(
self, name, type, tags=None, comment=None, parent=None, project=None, input=None, output_dest=None, execution=None, script=None, **kwargs):
super(CreateRequest, self).__init__(**kwargs)
self.name = name
self.tags = tags
self.type = type
self.comment = comment
self.parent = parent
self.project = project
self.input = input
self.output_dest = output_dest
self.execution = execution
self.script = script
@schema_property('name')
def name(self):
return self._property_name
@name.setter
def name(self, value):
if value is None:
self._property_name = None
return
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('tags')
def tags(self):
return self._property_tags
@tags.setter
def tags(self, value):
if value is None:
self._property_tags = None
return
self.assert_isinstance(value, "tags", (list, tuple))
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('type')
def type(self):
return self._property_type
@type.setter
def type(self, value):
if value is None:
self._property_type = None
return
if isinstance(value, six.string_types):
try:
value = TaskTypeEnum(value)
except ValueError:
pass
else:
self.assert_isinstance(value, "type", enum.Enum)
self._property_type = value
@schema_property('comment')
def comment(self):
return self._property_comment
@comment.setter
def comment(self, value):
if value is None:
self._property_comment = None
return
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = value
@schema_property('parent')
def parent(self):
return self._property_parent
@parent.setter
def parent(self, value):
if value is None:
self._property_parent = None
return
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = value
@schema_property('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
self.assert_isinstance(value, "project", six.string_types)
self._property_project = value
@schema_property('input')
def input(self):
return self._property_input
@input.setter
def input(self, value):
self._property_input = value
@schema_property('output_dest')
def output_dest(self):
return self._property_output_dest
@output_dest.setter
def output_dest(self, value):
if value is None:
self._property_output_dest = None
return
self.assert_isinstance(value, "output_dest", six.string_types)
self._property_output_dest = value
@schema_property('execution')
def execution(self):
return self._property_execution
@execution.setter
def execution(self, value):
if value is None:
self._property_execution = None
return
if isinstance(value, dict):
value = Execution.from_dict(value)
else:
self.assert_isinstance(value, "execution", Execution)
self._property_execution = value
@schema_property('script')
def script(self):
return self._property_script
@script.setter
def script(self, value):
if value is None:
self._property_script = None
return
if isinstance(value, dict):
value = Script.from_dict(value)
else:
self.assert_isinstance(value, "script", Script)
self._property_script = value
class CreateResponse(Response):
"""
Response of tasks.create endpoint.
:param id: ID of the task
:type id: str
"""
_service = "tasks"
_action = "create"
_version = "1.9"
_schema = {
'definitions': {},
'properties': {
'id': {'description': 'ID of the task', 'type': ['string', 'null']},
},
'type': 'object',
}
def __init__(
self, id=None, **kwargs):
super(CreateResponse, self).__init__(**kwargs)
self.id = id
@schema_property('id')
def id(self):
return self._property_id
@id.setter
def id(self, value):
if value is None:
self._property_id = None
return
self.assert_isinstance(value, "id", six.string_types)
self._property_id = value
class DeleteRequest(Request):
"""
Delete a task along with any information stored for it (statistics, frame updates etc.)
Unless Force flag is provided, operation will fail if task has objects associated with it - i.e. children tasks and projects.
Models that refer to the deleted task will be updated with a task ID indicating a deleted task.
:param move_to_trash: Move task to trash instead of deleting it. For internal
use only, tasks in the trash are not visible from the API and cannot be
restored!
:type move_to_trash: bool
:param force: If not true, call fails if the task status is 'in_progress'
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "delete"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': "If not true, call fails if the task status is 'in_progress'",
'type': ['boolean', 'null'],
},
'move_to_trash': {
'default': False,
'description': 'Move task to trash instead of deleting it. For internal use only, tasks in the trash are not visible from the API and cannot be restored!',
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, move_to_trash=False, force=False, status_reason=None, status_message=None, **kwargs):
super(DeleteRequest, self).__init__(**kwargs)
self.move_to_trash = move_to_trash
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('move_to_trash')
def move_to_trash(self):
return self._property_move_to_trash
@move_to_trash.setter
def move_to_trash(self, value):
if value is None:
self._property_move_to_trash = None
return
self.assert_isinstance(value, "move_to_trash", (bool,))
self._property_move_to_trash = value
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class DeleteResponse(Response):
"""
Response of tasks.delete endpoint.
:param deleted: Indicates whether the task was deleted
:type deleted: bool
:param updated_children: Number of child tasks whose parent property was
updated
:type updated_children: int
:param updated_models: Number of models whose task property was updated
:type updated_models: int
:param updated_versions: Number of dataset versions whose task property was
updated
:type updated_versions: int
:param frames: Response from frames.rollback
:type frames: dict
:param events: Response from events.delete_for_task
:type events: dict
"""
_service = "tasks"
_action = "delete"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'deleted': {
'description': 'Indicates whether the task was deleted',
'type': ['boolean', 'null'],
},
'events': {
'additionalProperties': True,
'description': 'Response from events.delete_for_task',
'type': ['object', 'null'],
},
'frames': {
'additionalProperties': True,
'description': 'Response from frames.rollback',
'type': ['object', 'null'],
},
'updated_children': {
'description': 'Number of child tasks whose parent property was updated',
'type': ['integer', 'null'],
},
'updated_models': {
'description': 'Number of models whose task property was updated',
'type': ['integer', 'null'],
},
'updated_versions': {
'description': 'Number of dataset versions whose task property was updated',
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, deleted=None, updated_children=None, updated_models=None, updated_versions=None, frames=None, events=None, **kwargs):
super(DeleteResponse, self).__init__(**kwargs)
self.deleted = deleted
self.updated_children = updated_children
self.updated_models = updated_models
self.updated_versions = updated_versions
self.frames = frames
self.events = events
@schema_property('deleted')
def deleted(self):
return self._property_deleted
@deleted.setter
def deleted(self, value):
if value is None:
self._property_deleted = None
return
self.assert_isinstance(value, "deleted", (bool,))
self._property_deleted = value
@schema_property('updated_children')
def updated_children(self):
return self._property_updated_children
@updated_children.setter
def updated_children(self, value):
if value is None:
self._property_updated_children = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated_children", six.integer_types)
self._property_updated_children = value
@schema_property('updated_models')
def updated_models(self):
return self._property_updated_models
@updated_models.setter
def updated_models(self, value):
if value is None:
self._property_updated_models = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated_models", six.integer_types)
self._property_updated_models = value
@schema_property('updated_versions')
def updated_versions(self):
return self._property_updated_versions
@updated_versions.setter
def updated_versions(self, value):
if value is None:
self._property_updated_versions = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated_versions", six.integer_types)
self._property_updated_versions = value
@schema_property('frames')
def frames(self):
return self._property_frames
@frames.setter
def frames(self, value):
if value is None:
self._property_frames = None
return
self.assert_isinstance(value, "frames", (dict,))
self._property_frames = value
@schema_property('events')
def events(self):
return self._property_events
@events.setter
def events(self, value):
if value is None:
self._property_events = None
return
self.assert_isinstance(value, "events", (dict,))
self._property_events = value
class EditRequest(Request):
"""
Edit task's details.
:param task: ID of the task
:type task: str
:param force: If not true, call fails if the task status is not 'created'
:type force: bool
:param name: Task name Unique within the company.
:type name: str
:param tags: Tags list
:type tags: Sequence[str]
:param type: Type of task
:type type: TaskTypeEnum
:param comment: Free text comment
:type comment: str
:param parent: Parent task id Must be a completed task.
:type parent: str
:param project: Project ID of the project to which this task is assigned Must
exist[ab]
:type project: str
:param output_dest: Output storage id Must be a reference to an existing
storage.
:type output_dest: str
:param execution: Task execution params
:type execution: Execution
:param script: Script info
:type script: Script
"""
_service = "tasks"
_action = "edit"
_version = "1.9"
_schema = {
'definitions': {
'execution': {
'properties': {
'framework': {
'description': 'Framework related to the task. Case insensitive. Mandatory for Training tasks. ',
'type': ['string', 'null'],
},
'model': {
'description': 'Execution input model ID Not applicable for Register (Import) tasks',
'type': ['string', 'null'],
},
'model_desc': {
'additionalProperties': True,
'description': 'Json object representing the Model descriptors',
'type': ['object', 'null'],
},
'model_labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model.\n The keys are the layers' names and the values are the IDs.\n Not applicable for Register (Import) tasks.\n Mandatory for Training tasks",
'type': ['object', 'null'],
},
'parameters': {
'additionalProperties': True,
'description': 'Json object containing the Task parameters',
'type': ['object', 'null'],
},
},
'type': 'object',
},
'script': {
'properties': {
'binary': {
'default': 'python',
'description': 'Binary to use when running the script',
'type': ['string', 'null'],
},
'branch': {
'description': 'Repository branch id If not provided and tag not provided, default repository branch is used.',
'type': ['string', 'null'],
},
'diff': {
'description': 'Uncommitted changes found in the repository when task was run',
'type': ['string', 'null'],
},
'entry_point': {
'description': 'Path to execute within the repository',
'type': ['string', 'null'],
},
'repository': {
'description': 'Name of the repository where the script is located',
'type': ['string', 'null'],
},
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': ['object', 'null'],
},
'tag': {
'description': 'Repository tag',
'type': ['string', 'null'],
},
'version_num': {
'description': 'Version (changeset) number. Optional (default is head version) Unused if tag is provided.',
'type': ['string', 'null'],
},
'working_dir': {
'description': 'Path to the folder from which to run the script Default - root folder of repository',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task_type_enum': {'enum': ['training', 'testing'], 'type': 'string'},
},
'properties': {
'comment': {'description': 'Free text comment ', 'type': 'string'},
'execution': {
'$ref': '#/definitions/execution',
'description': 'Task execution params',
},
'force': {
'default': False,
'description': "If not true, call fails if the task status is not 'created'",
'type': 'boolean',
},
'name': {
'description': 'Task name Unique within the company.',
'type': 'string',
},
'output_dest': {
'description': 'Output storage id Must be a reference to an existing storage.',
'type': 'string',
},
'parent': {
'description': 'Parent task id Must be a completed task.',
'type': 'string',
},
'project': {
'description': 'Project ID of the project to which this task is assigned Must exist[ab]',
'type': 'string',
},
'script': {
'$ref': '#/definitions/script',
'description': 'Script info',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'task': {'description': 'ID of the task', 'type': 'string'},
'type': {
'$ref': '#/definitions/task_type_enum',
'description': 'Type of task',
},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, name=None, tags=None, type=None, comment=None, parent=None, project=None, output_dest=None, execution=None, script=None, **kwargs):
super(EditRequest, self).__init__(**kwargs)
self.task = task
self.force = force
self.name = name
self.tags = tags
self.type = type
self.comment = comment
self.parent = parent
self.project = project
self.output_dest = output_dest
self.execution = execution
self.script = script
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('name')
def name(self):
return self._property_name
@name.setter
def name(self, value):
if value is None:
self._property_name = None
return
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('tags')
def tags(self):
return self._property_tags
@tags.setter
def tags(self, value):
if value is None:
self._property_tags = None
return
self.assert_isinstance(value, "tags", (list, tuple))
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('type')
def type(self):
return self._property_type
@type.setter
def type(self, value):
if value is None:
self._property_type = None
return
if isinstance(value, six.string_types):
try:
value = TaskTypeEnum(value)
except ValueError:
pass
else:
self.assert_isinstance(value, "type", enum.Enum)
self._property_type = value
@schema_property('comment')
def comment(self):
return self._property_comment
@comment.setter
def comment(self, value):
if value is None:
self._property_comment = None
return
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = value
@schema_property('parent')
def parent(self):
return self._property_parent
@parent.setter
def parent(self, value):
if value is None:
self._property_parent = None
return
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = value
@schema_property('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
self.assert_isinstance(value, "project", six.string_types)
self._property_project = value
@schema_property('output_dest')
def output_dest(self):
return self._property_output_dest
@output_dest.setter
def output_dest(self, value):
if value is None:
self._property_output_dest = None
return
self.assert_isinstance(value, "output_dest", six.string_types)
self._property_output_dest = value
@schema_property('execution')
def execution(self):
return self._property_execution
@execution.setter
def execution(self, value):
if value is None:
self._property_execution = None
return
if isinstance(value, dict):
value = Execution.from_dict(value)
else:
self.assert_isinstance(value, "execution", Execution)
self._property_execution = value
@schema_property('script')
def script(self):
return self._property_script
@script.setter
def script(self, value):
if value is None:
self._property_script = None
return
if isinstance(value, dict):
value = Script.from_dict(value)
else:
self.assert_isinstance(value, "script", Script)
self._property_script = value
class EditResponse(Response):
"""
Response of tasks.edit endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "edit"
_version = "1.9"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(EditResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class FailedRequest(Request):
"""
Indicates that task has failed
:param force: Allows forcing state change even if transition is not supported
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "failed"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': 'Allows forcing state change even if transition is not supported',
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(FailedRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class FailedResponse(Response):
"""
Response of tasks.failed endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "failed"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(FailedResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class GetAllRequest(Request):
"""
Get all the company's tasks and all public tasks
:param id: List of IDs to filter by
:type id: Sequence[str]
:param name: Get only tasks whose name matches this pattern (python regular
expression syntax)
:type name: str
:param user: List of user IDs used to filter results by the task's creating
user
:type user: Sequence[str]
:param project: List of project IDs
:type project: Sequence[str]
:param page: Page number, returns a specific page out of the resulting list of
tasks
:type page: int
:param page_size: Page size, specifies the number of results returned in each
page (last page may contain fewer results)
:type page_size: int
:param order_by: List of field names to order by. When search_text is used,
'@text_score' can be used as a field representing the text score of returned
documents. Use '-' prefix to specify descending order. Optional, recommended
when using page
:type order_by: Sequence[str]
:param type: List of task types. One or more of: 'training' or 'testing' (case insensitive)
:type type: Sequence[str]
:param tags: List of task tags. Use '-' prefix to exclude tags
:type tags: Sequence[str]
:param status: List of task status.
:type status: Sequence[TaskStatusEnum]
:param only_fields: List of task field names (nesting is supported using '.',
e.g. execution.model_labels). If provided, this list defines the query's
projection (only these fields will be returned for each result entry)
:type only_fields: Sequence[str]
:param parent: Parent ID
:type parent: str
:param status_changed: List of status changed constraint strings (utcformat,
epoch) with an optional prefix modifier (>, >=, <, <=)
:type status_changed: Sequence[str]
:param search_text: Free text search query
:type search_text: str
:param _all_: Multi-field pattern condition (all fields match pattern)
:type _all_: MultiFieldPatternData
:param _any_: Multi-field pattern condition (any field matches pattern)
:type _any_: MultiFieldPatternData
"""
_service = "tasks"
_action = "get_all"
_version = "1.9"
_schema = {
'definitions': {
'multi_field_pattern_data': {
'properties': {
'fields': {
'description': 'List of field names',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'pattern': {
'description': 'Pattern string (regex)',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task_status_enum': {
'enum': [
'created',
'in_progress',
'stopped',
'published',
'publishing',
'closed',
'failed',
'unknown',
],
'type': 'string',
},
},
'dependencies': {'page': ['page_size']},
'properties': {
'_all_': {
'description': 'Multi-field pattern condition (all fields match pattern)',
'oneOf': [
{'$ref': '#/definitions/multi_field_pattern_data'},
{'type': 'null'},
],
},
'_any_': {
'description': 'Multi-field pattern condition (any field matches pattern)',
'oneOf': [
{'$ref': '#/definitions/multi_field_pattern_data'},
{'type': 'null'},
],
},
'id': {
'description': 'List of IDs to filter by',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'name': {
'description': 'Get only tasks whose name matches this pattern (python regular expression syntax)',
'type': ['string', 'null'],
},
'only_fields': {
'description': "List of task field names (nesting is supported using '.', e.g. execution.model_labels). If provided, this list defines the query's projection (only these fields will be returned for each result entry)",
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'order_by': {
'description': "List of field names to order by. When search_text is used, '@text_score' can be used as a field representing the text score of returned documents. Use '-' prefix to specify descending order. Optional, recommended when using page",
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'page': {
'description': 'Page number, returns a specific page out of the resulting list of tasks',
'minimum': 0,
'type': ['integer', 'null'],
},
'page_size': {
'description': 'Page size, specifies the number of results returned in each page (last page may contain fewer results)',
'minimum': 1,
'type': ['integer', 'null'],
},
'parent': {'description': 'Parent ID', 'type': ['string', 'null']},
'project': {
'description': 'List of project IDs',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'search_text': {
'description': 'Free text search query',
'type': ['string', 'null'],
},
'status': {
'description': 'List of task status.',
'items': {'$ref': '#/definitions/task_status_enum'},
'type': ['array', 'null'],
},
'status_changed': {
'description': 'List of status changed constraint strings (utcformat, epoch) with an optional prefix modifier (>, >=, <, <=)',
'items': {'pattern': '^(>=|>|<=|<)?.*$', 'type': 'string'},
'type': ['array', 'null'],
},
'tags': {
'description': "List of task tags. Use '-' prefix to exclude tags",
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'type': {
'description': "List of task types. One or more of: 'training' or 'testing' (case insensitive)",
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'user': {
'description': "List of user IDs used to filter results by the task's creating user",
'items': {'type': 'string'},
'type': ['array', 'null'],
},
},
'type': 'object',
}
def __init__(
self, id=None, name=None, user=None, project=None, page=None, page_size=None, order_by=None, type=None, tags=None, status=None, only_fields=None, parent=None, status_changed=None, search_text=None, _all_=None, _any_=None, **kwargs):
super(GetAllRequest, self).__init__(**kwargs)
self.id = id
self.name = name
self.user = user
self.project = project
self.page = page
self.page_size = page_size
self.order_by = order_by
self.type = type
self.tags = tags
self.status = status
self.only_fields = only_fields
self.parent = parent
self.status_changed = status_changed
self.search_text = search_text
self._all_ = _all_
self._any_ = _any_
@schema_property('id')
def id(self):
return self._property_id
@id.setter
def id(self, value):
if value is None:
self._property_id = None
return
self.assert_isinstance(value, "id", (list, tuple))
self.assert_isinstance(value, "id", six.string_types, is_array=True)
self._property_id = value
@schema_property('name')
def name(self):
return self._property_name
@name.setter
def name(self, value):
if value is None:
self._property_name = None
return
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('user')
def user(self):
return self._property_user
@user.setter
def user(self, value):
if value is None:
self._property_user = None
return
self.assert_isinstance(value, "user", (list, tuple))
self.assert_isinstance(value, "user", six.string_types, is_array=True)
self._property_user = value
@schema_property('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
self.assert_isinstance(value, "project", (list, tuple))
self.assert_isinstance(value, "project", six.string_types, is_array=True)
self._property_project = value
@schema_property('page')
def page(self):
return self._property_page
@page.setter
def page(self, value):
if value is None:
self._property_page = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "page", six.integer_types)
self._property_page = value
@schema_property('page_size')
def page_size(self):
return self._property_page_size
@page_size.setter
def page_size(self, value):
if value is None:
self._property_page_size = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "page_size", six.integer_types)
self._property_page_size = value
@schema_property('order_by')
def order_by(self):
return self._property_order_by
@order_by.setter
def order_by(self, value):
if value is None:
self._property_order_by = None
return
self.assert_isinstance(value, "order_by", (list, tuple))
self.assert_isinstance(value, "order_by", six.string_types, is_array=True)
self._property_order_by = value
@schema_property('type')
def type(self):
return self._property_type
@type.setter
def type(self, value):
if value is None:
self._property_type = None
return
self.assert_isinstance(value, "type", (list, tuple))
self.assert_isinstance(value, "type", six.string_types, is_array=True)
self._property_type = value
@schema_property('tags')
def tags(self):
return self._property_tags
@tags.setter
def tags(self, value):
if value is None:
self._property_tags = None
return
self.assert_isinstance(value, "tags", (list, tuple))
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('status')
def status(self):
return self._property_status
@status.setter
def status(self, value):
if value is None:
self._property_status = None
return
self.assert_isinstance(value, "status", (list, tuple))
if any(isinstance(v, six.string_types) for v in value):
value = [TaskStatusEnum(v) if isinstance(v, six.string_types) else v for v in value]
else:
self.assert_isinstance(value, "status", TaskStatusEnum, is_array=True)
self._property_status = value
@schema_property('only_fields')
def only_fields(self):
return self._property_only_fields
@only_fields.setter
def only_fields(self, value):
if value is None:
self._property_only_fields = None
return
self.assert_isinstance(value, "only_fields", (list, tuple))
self.assert_isinstance(value, "only_fields", six.string_types, is_array=True)
self._property_only_fields = value
@schema_property('parent')
def parent(self):
return self._property_parent
@parent.setter
def parent(self, value):
if value is None:
self._property_parent = None
return
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = value
@schema_property('status_changed')
def status_changed(self):
return self._property_status_changed
@status_changed.setter
def status_changed(self, value):
if value is None:
self._property_status_changed = None
return
self.assert_isinstance(value, "status_changed", (list, tuple))
self.assert_isinstance(value, "status_changed", six.string_types, is_array=True)
self._property_status_changed = value
@schema_property('search_text')
def search_text(self):
return self._property_search_text
@search_text.setter
def search_text(self, value):
if value is None:
self._property_search_text = None
return
self.assert_isinstance(value, "search_text", six.string_types)
self._property_search_text = value
@schema_property('_all_')
def _all_(self):
return self._property__all_
@_all_.setter
def _all_(self, value):
if value is None:
self._property__all_ = None
return
if isinstance(value, dict):
value = MultiFieldPatternData.from_dict(value)
else:
self.assert_isinstance(value, "_all_", MultiFieldPatternData)
self._property__all_ = value
@schema_property('_any_')
def _any_(self):
return self._property__any_
@_any_.setter
def _any_(self, value):
if value is None:
self._property__any_ = None
return
if isinstance(value, dict):
value = MultiFieldPatternData.from_dict(value)
else:
self.assert_isinstance(value, "_any_", MultiFieldPatternData)
self._property__any_ = value
class GetAllResponse(Response):
"""
Response of tasks.get_all endpoint.
:param tasks: List of tasks
:type tasks: Sequence[Task]
"""
_service = "tasks"
_action = "get_all"
_version = "1.9"
_schema = {
'definitions': {
'execution': {
'properties': {
'framework': {
'description': 'Framework related to the task. Case insensitive. Mandatory for Training tasks. ',
'type': ['string', 'null'],
},
'model': {
'description': 'Execution input model ID Not applicable for Register (Import) tasks',
'type': ['string', 'null'],
},
'model_desc': {
'additionalProperties': True,
'description': 'Json object representing the Model descriptors',
'type': ['object', 'null'],
},
'model_labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model.\n The keys are the layers' names and the values are the IDs.\n Not applicable for Register (Import) tasks.\n Mandatory for Training tasks",
'type': ['object', 'null'],
},
'parameters': {
'additionalProperties': True,
'description': 'Json object containing the Task parameters',
'type': ['object', 'null'],
},
},
'type': 'object',
},
'last_metrics_event': {
'properties': {
'iter': {
'description': 'Iteration number',
'type': ['integer', 'null'],
},
'metric': {
'description': 'Metric name',
'type': ['string', 'null'],
},
'timestamp': {
'description': 'Event report time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'type': {
'description': 'Event type',
'type': ['string', 'null'],
},
'value': {'description': 'Value', 'type': ['number', 'null']},
'variant': {
'description': 'Variant name',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'last_metrics_variants': {
'additionalProperties': {
'$ref': '#/definitions/last_metrics_event',
},
'description': 'Last metric events, one for each variant hash',
'type': 'object',
},
'output': {
'properties': {
'destination': {
'description': 'Storage id. This is where output files will be stored.',
'type': ['string', 'null'],
},
'error': {
'description': 'Last error text',
'type': ['string', 'null'],
},
'model': {
'description': 'Model id.',
'type': ['string', 'null'],
},
'result': {
'description': "Task result. Values: 'success', 'failure'",
'type': ['string', 'null'],
},
},
'type': 'object',
},
'script': {
'properties': {
'binary': {
'default': 'python',
'description': 'Binary to use when running the script',
'type': ['string', 'null'],
},
'branch': {
'description': 'Repository branch id If not provided and tag not provided, default repository branch is used.',
'type': ['string', 'null'],
},
'diff': {
'description': 'Uncommitted changes found in the repository when task was run',
'type': ['string', 'null'],
},
'entry_point': {
'description': 'Path to execute within the repository',
'type': ['string', 'null'],
},
'repository': {
'description': 'Name of the repository where the script is located',
'type': ['string', 'null'],
},
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': ['object', 'null'],
},
'tag': {
'description': 'Repository tag',
'type': ['string', 'null'],
},
'version_num': {
'description': 'Version (changeset) number. Optional (default is head version) Unused if tag is provided.',
'type': ['string', 'null'],
},
'working_dir': {
'description': 'Path to the folder from which to run the script Default - root folder of repository',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task': {
'properties': {
'comment': {
'description': 'Free text comment',
'type': ['string', 'null'],
},
'company': {
'description': 'Company ID',
'type': ['string', 'null'],
},
'completed': {
'description': 'Task end time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'created': {
'description': 'Task creation time (UTC) ',
'format': 'date-time',
'type': ['string', 'null'],
},
'execution': {
'description': 'Task execution params',
'oneOf': [
{'$ref': '#/definitions/execution'},
{'type': 'null'},
],
},
'id': {'description': 'Task id', 'type': ['string', 'null']},
'last_iteration': {
'description': 'Last iteration reported for this task',
'type': ['integer', 'null'],
},
'last_metrics': {
'additionalProperties': {
'$ref': '#/definitions/last_metrics_variants',
},
'description': 'Last metric variants (hash to events), one for each metric hash',
'type': ['object', 'null'],
},
'last_update': {
'description': 'Last time this task was created, updated, changed or events for this task were reported',
'format': 'date-time',
'type': ['string', 'null'],
},
'name': {
'description': 'Task Name',
'type': ['string', 'null'],
},
'output': {
'description': 'Task output params',
'oneOf': [
{'$ref': '#/definitions/output'},
{'type': 'null'},
],
},
'parent': {
'description': 'Parent task id',
'type': ['string', 'null'],
},
'project': {
'description': 'Project ID of the project to which this task is assigned',
'type': ['string', 'null'],
},
'published': {
'description': 'Last status change time',
'format': 'date-time',
'type': ['string', 'null'],
},
'script': {
'description': 'Script info',
'oneOf': [
{'$ref': '#/definitions/script'},
{'type': 'null'},
],
},
'started': {
'description': 'Task start time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'status': {
'description': '',
'oneOf': [
{'$ref': '#/definitions/task_status_enum'},
{'type': 'null'},
],
},
'status_changed': {
'description': 'Last status change time',
'format': 'date-time',
'type': ['string', 'null'],
},
'status_message': {
'description': 'free text string representing info about the status',
'type': ['string', 'null'],
},
'status_reason': {
'description': 'Reason for last status change',
'type': ['string', 'null'],
},
'tags': {
'description': 'Tags list',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'type': {
'description': "Type of task. Values: 'training', 'testing'",
'oneOf': [
{'$ref': '#/definitions/task_type_enum'},
{'type': 'null'},
],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task_status_enum': {
'enum': [
'created',
'in_progress',
'stopped',
'published',
'publishing',
'closed',
'failed',
'unknown',
],
'type': 'string',
},
'task_type_enum': {'enum': ['training', 'testing'], 'type': 'string'},
},
'properties': {
'tasks': {
'description': 'List of tasks',
'items': {'$ref': '#/definitions/task'},
'type': ['array', 'null'],
},
},
'type': 'object',
}
def __init__(
self, tasks=None, **kwargs):
super(GetAllResponse, self).__init__(**kwargs)
self.tasks = tasks
@schema_property('tasks')
def tasks(self):
return self._property_tasks
@tasks.setter
def tasks(self, value):
if value is None:
self._property_tasks = None
return
self.assert_isinstance(value, "tasks", (list, tuple))
if any(isinstance(v, dict) for v in value):
value = [Task.from_dict(v) if isinstance(v, dict) else v for v in value]
else:
self.assert_isinstance(value, "tasks", Task, is_array=True)
self._property_tasks = value
class GetByIdRequest(Request):
"""
Gets task information
:param task: Task ID
:type task: str
"""
_service = "tasks"
_action = "get_by_id"
_version = "1.9"
_schema = {
'definitions': {},
'properties': {'task': {'description': 'Task ID', 'type': 'string'}},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, **kwargs):
super(GetByIdRequest, self).__init__(**kwargs)
self.task = task
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
class GetByIdResponse(Response):
"""
Response of tasks.get_by_id endpoint.
:param task: Task info
:type task: Task
"""
_service = "tasks"
_action = "get_by_id"
_version = "1.9"
_schema = {
'definitions': {
'execution': {
'properties': {
'framework': {
'description': 'Framework related to the task. Case insensitive. Mandatory for Training tasks. ',
'type': ['string', 'null'],
},
'model': {
'description': 'Execution input model ID Not applicable for Register (Import) tasks',
'type': ['string', 'null'],
},
'model_desc': {
'additionalProperties': True,
'description': 'Json object representing the Model descriptors',
'type': ['object', 'null'],
},
'model_labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model.\n The keys are the layers' names and the values are the IDs.\n Not applicable for Register (Import) tasks.\n Mandatory for Training tasks",
'type': ['object', 'null'],
},
'parameters': {
'additionalProperties': True,
'description': 'Json object containing the Task parameters',
'type': ['object', 'null'],
},
},
'type': 'object',
},
'last_metrics_event': {
'properties': {
'iter': {
'description': 'Iteration number',
'type': ['integer', 'null'],
},
'metric': {
'description': 'Metric name',
'type': ['string', 'null'],
},
'timestamp': {
'description': 'Event report time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'type': {
'description': 'Event type',
'type': ['string', 'null'],
},
'value': {'description': 'Value', 'type': ['number', 'null']},
'variant': {
'description': 'Variant name',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'last_metrics_variants': {
'additionalProperties': {
'$ref': '#/definitions/last_metrics_event',
},
'description': 'Last metric events, one for each variant hash',
'type': 'object',
},
'output': {
'properties': {
'destination': {
'description': 'Storage id. This is where output files will be stored.',
'type': ['string', 'null'],
},
'error': {
'description': 'Last error text',
'type': ['string', 'null'],
},
'model': {
'description': 'Model id.',
'type': ['string', 'null'],
},
'result': {
'description': "Task result. Values: 'success', 'failure'",
'type': ['string', 'null'],
},
},
'type': 'object',
},
'script': {
'properties': {
'binary': {
'default': 'python',
'description': 'Binary to use when running the script',
'type': ['string', 'null'],
},
'branch': {
'description': 'Repository branch id If not provided and tag not provided, default repository branch is used.',
'type': ['string', 'null'],
},
'diff': {
'description': 'Uncommitted changes found in the repository when task was run',
'type': ['string', 'null'],
},
'entry_point': {
'description': 'Path to execute within the repository',
'type': ['string', 'null'],
},
'repository': {
'description': 'Name of the repository where the script is located',
'type': ['string', 'null'],
},
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': ['object', 'null'],
},
'tag': {
'description': 'Repository tag',
'type': ['string', 'null'],
},
'version_num': {
'description': 'Version (changeset) number. Optional (default is head version) Unused if tag is provided.',
'type': ['string', 'null'],
},
'working_dir': {
'description': 'Path to the folder from which to run the script Default - root folder of repository',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task': {
'properties': {
'comment': {
'description': 'Free text comment',
'type': ['string', 'null'],
},
'company': {
'description': 'Company ID',
'type': ['string', 'null'],
},
'completed': {
'description': 'Task end time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'created': {
'description': 'Task creation time (UTC) ',
'format': 'date-time',
'type': ['string', 'null'],
},
'execution': {
'description': 'Task execution params',
'oneOf': [
{'$ref': '#/definitions/execution'},
{'type': 'null'},
],
},
'id': {'description': 'Task id', 'type': ['string', 'null']},
'last_iteration': {
'description': 'Last iteration reported for this task',
'type': ['integer', 'null'],
},
'last_metrics': {
'additionalProperties': {
'$ref': '#/definitions/last_metrics_variants',
},
'description': 'Last metric variants (hash to events), one for each metric hash',
'type': ['object', 'null'],
},
'last_update': {
'description': 'Last time this task was created, updated, changed or events for this task were reported',
'format': 'date-time',
'type': ['string', 'null'],
},
'name': {
'description': 'Task Name',
'type': ['string', 'null'],
},
'output': {
'description': 'Task output params',
'oneOf': [
{'$ref': '#/definitions/output'},
{'type': 'null'},
],
},
'parent': {
'description': 'Parent task id',
'type': ['string', 'null'],
},
'project': {
'description': 'Project ID of the project to which this task is assigned',
'type': ['string', 'null'],
},
'published': {
'description': 'Last status change time',
'format': 'date-time',
'type': ['string', 'null'],
},
'script': {
'description': 'Script info',
'oneOf': [
{'$ref': '#/definitions/script'},
{'type': 'null'},
],
},
'started': {
'description': 'Task start time (UTC)',
'format': 'date-time',
'type': ['string', 'null'],
},
'status': {
'description': '',
'oneOf': [
{'$ref': '#/definitions/task_status_enum'},
{'type': 'null'},
],
},
'status_changed': {
'description': 'Last status change time',
'format': 'date-time',
'type': ['string', 'null'],
},
'status_message': {
'description': 'free text string representing info about the status',
'type': ['string', 'null'],
},
'status_reason': {
'description': 'Reason for last status change',
'type': ['string', 'null'],
},
'tags': {
'description': 'Tags list',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'type': {
'description': "Type of task. Values: 'training', 'testing'",
'oneOf': [
{'$ref': '#/definitions/task_type_enum'},
{'type': 'null'},
],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task_status_enum': {
'enum': [
'created',
'in_progress',
'stopped',
'published',
'publishing',
'closed',
'failed',
'unknown',
],
'type': 'string',
},
'task_type_enum': {'enum': ['training', 'testing'], 'type': 'string'},
},
'properties': {
'task': {
'description': 'Task info',
'oneOf': [{'$ref': '#/definitions/task'}, {'type': 'null'}],
},
},
'type': 'object',
}
def __init__(
self, task=None, **kwargs):
super(GetByIdResponse, self).__init__(**kwargs)
self.task = task
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
if isinstance(value, dict):
value = Task.from_dict(value)
else:
self.assert_isinstance(value, "task", Task)
self._property_task = value
class PingRequest(Request):
"""
Refresh the task's last update time
:param task: Task ID
:type task: str
"""
_service = "tasks"
_action = "ping"
_version = "2.1"
_schema = {
'definitions': {},
'properties': {'task': {'description': 'Task ID', 'type': 'string'}},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, **kwargs):
super(PingRequest, self).__init__(**kwargs)
self.task = task
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
class PingResponse(Response):
"""
Response of tasks.ping endpoint.
"""
_service = "tasks"
_action = "ping"
_version = "2.1"
_schema = {'additionalProperties': False, 'definitions': {}, 'type': 'object'}
class PublishRequest(Request):
"""
Mark a task status as published. If a model was created, it should be set to ready.
:param force: If not true, call fails if the task status is not 'stopped'
:type force: bool
:param publish_model: Indicates that the task output model (if exists) should
be published. Optional, the default value is True.
:type publish_model: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "publish"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': "If not true, call fails if the task status is not 'stopped'",
'type': ['boolean', 'null'],
},
'publish_model': {
'description': 'Indicates that the task output model (if exists) should be published. Optional, the default value is True.',
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, publish_model=None, status_reason=None, status_message=None, **kwargs):
super(PublishRequest, self).__init__(**kwargs)
self.force = force
self.publish_model = publish_model
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('publish_model')
def publish_model(self):
return self._property_publish_model
@publish_model.setter
def publish_model(self, value):
if value is None:
self._property_publish_model = None
return
self.assert_isinstance(value, "publish_model", (bool,))
self._property_publish_model = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class PublishResponse(Response):
"""
Response of tasks.publish endpoint.
:param committed_versions_results: Committed versions results
:type committed_versions_results: Sequence[dict]
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "publish"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'committed_versions_results': {
'description': 'Committed versions results',
'items': {'additionalProperties': True, 'type': 'object'},
'type': ['array', 'null'],
},
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, committed_versions_results=None, updated=None, fields=None, **kwargs):
super(PublishResponse, self).__init__(**kwargs)
self.committed_versions_results = committed_versions_results
self.updated = updated
self.fields = fields
@schema_property('committed_versions_results')
def committed_versions_results(self):
return self._property_committed_versions_results
@committed_versions_results.setter
def committed_versions_results(self, value):
if value is None:
self._property_committed_versions_results = None
return
self.assert_isinstance(value, "committed_versions_results", (list, tuple))
self.assert_isinstance(value, "committed_versions_results", (dict,), is_array=True)
self._property_committed_versions_results = value
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class ResetRequest(Request):
"""
Reset a task to its initial state, along with any information stored for it (statistics, frame updates etc.).
:param force: If not true, call fails if the task status is 'completed'
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "reset"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': "If not true, call fails if the task status is 'completed'",
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(ResetRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class ResetResponse(Response):
"""
Response of tasks.reset endpoint.
:param deleted_indices: List of deleted ES indices that were removed as part of
the reset process
:type deleted_indices: Sequence[str]
:param frames: Response from frames.rollback
:type frames: dict
:param events: Response from events.delete_for_task
:type events: dict
:param deleted_models: Number of output models deleted by the reset
:type deleted_models: int
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "reset"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'deleted_indices': {
'description': 'List of deleted ES indices that were removed as part of the reset process',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'deleted_models': {
'description': 'Number of output models deleted by the reset',
'type': ['integer', 'null'],
},
'events': {
'additionalProperties': True,
'description': 'Response from events.delete_for_task',
'type': ['object', 'null'],
},
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'frames': {
'additionalProperties': True,
'description': 'Response from frames.rollback',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, deleted_indices=None, frames=None, events=None, deleted_models=None, updated=None, fields=None, **kwargs):
super(ResetResponse, self).__init__(**kwargs)
self.deleted_indices = deleted_indices
self.frames = frames
self.events = events
self.deleted_models = deleted_models
self.updated = updated
self.fields = fields
@schema_property('deleted_indices')
def deleted_indices(self):
return self._property_deleted_indices
@deleted_indices.setter
def deleted_indices(self, value):
if value is None:
self._property_deleted_indices = None
return
self.assert_isinstance(value, "deleted_indices", (list, tuple))
self.assert_isinstance(value, "deleted_indices", six.string_types, is_array=True)
self._property_deleted_indices = value
@schema_property('frames')
def frames(self):
return self._property_frames
@frames.setter
def frames(self, value):
if value is None:
self._property_frames = None
return
self.assert_isinstance(value, "frames", (dict,))
self._property_frames = value
@schema_property('events')
def events(self):
return self._property_events
@events.setter
def events(self, value):
if value is None:
self._property_events = None
return
self.assert_isinstance(value, "events", (dict,))
self._property_events = value
@schema_property('deleted_models')
def deleted_models(self):
return self._property_deleted_models
@deleted_models.setter
def deleted_models(self, value):
if value is None:
self._property_deleted_models = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "deleted_models", six.integer_types)
self._property_deleted_models = value
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class SetRequirementsRequest(Request):
"""
Set the script requirements for a task
:param task: Task ID
:type task: str
:param requirements: A JSON object containing requirements strings by key
:type requirements: dict
"""
_service = "tasks"
_action = "set_requirements"
_version = "1.6"
_schema = {
'definitions': {},
'properties': {
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': 'object',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task', 'requirements'],
'type': 'object',
}
def __init__(
self, task, requirements, **kwargs):
super(SetRequirementsRequest, self).__init__(**kwargs)
self.task = task
self.requirements = requirements
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('requirements')
def requirements(self):
return self._property_requirements
@requirements.setter
def requirements(self, value):
if value is None:
self._property_requirements = None
return
self.assert_isinstance(value, "requirements", (dict,))
self._property_requirements = value
class SetRequirementsResponse(Response):
"""
Response of tasks.set_requirements endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "set_requirements"
_version = "1.6"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(SetRequirementsResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class StartedRequest(Request):
"""
Mark a task status as in_progress. Optionally allows to set the task's execution progress.
:param force: If not true, call fails if the task status is not 'not_started'
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "started"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': "If not true, call fails if the task status is not 'not_started'",
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(StartedRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class StartedResponse(Response):
"""
Response of tasks.started endpoint.
:param started: Number of tasks started (0 or 1)
:type started: int
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "started"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'started': {
'description': 'Number of tasks started (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, started=None, updated=None, fields=None, **kwargs):
super(StartedResponse, self).__init__(**kwargs)
self.started = started
self.updated = updated
self.fields = fields
@schema_property('started')
def started(self):
return self._property_started
@started.setter
def started(self, value):
if value is None:
self._property_started = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "started", six.integer_types)
self._property_started = value
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class StopRequest(Request):
"""
Request to stop a running task
:param force: If not true, call fails if the task status is not 'in_progress'
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "stop"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': "If not true, call fails if the task status is not 'in_progress'",
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(StopRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class StopResponse(Response):
"""
Response of tasks.stop endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "stop"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(StopResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class StoppedRequest(Request):
"""
Signal a task has stopped
:param force: If not true, call fails if the task status is not 'stopped'
:type force: bool
:param task: Task ID
:type task: str
:param status_reason: Reason for status change
:type status_reason: str
:param status_message: Extra information regarding status change
:type status_message: str
"""
_service = "tasks"
_action = "stopped"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'default': False,
'description': "If not true, call fails if the task status is not 'stopped'",
'type': ['boolean', 'null'],
},
'status_message': {
'description': 'Extra information regarding status change',
'type': 'string',
},
'status_reason': {
'description': 'Reason for status change',
'type': 'string',
},
'task': {'description': 'Task ID', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, force=False, status_reason=None, status_message=None, **kwargs):
super(StoppedRequest, self).__init__(**kwargs)
self.force = force
self.task = task
self.status_reason = status_reason
self.status_message = status_message
@schema_property('force')
def force(self):
return self._property_force
@force.setter
def force(self, value):
if value is None:
self._property_force = None
return
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('status_reason')
def status_reason(self):
return self._property_status_reason
@status_reason.setter
def status_reason(self, value):
if value is None:
self._property_status_reason = None
return
self.assert_isinstance(value, "status_reason", six.string_types)
self._property_status_reason = value
@schema_property('status_message')
def status_message(self):
return self._property_status_message
@status_message.setter
def status_message(self, value):
if value is None:
self._property_status_message = None
return
self.assert_isinstance(value, "status_message", six.string_types)
self._property_status_message = value
class StoppedResponse(Response):
"""
Response of tasks.stopped endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "stopped"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(StoppedResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class UpdateRequest(Request):
"""
Update task's runtime parameters
:param task: ID of the task
:type task: str
:param name: Task name Unique within the company.
:type name: str
:param tags: Tags list
:type tags: Sequence[str]
:param comment: Free text comment
:type comment: str
:param project: Project ID of the project to which this task is assigned
:type project: str
:param output__error: Free text error
:type output__error: str
:param created: Task creation time (UTC)
:type created: datetime.datetime
"""
_service = "tasks"
_action = "update"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'comment': {'description': 'Free text comment ', 'type': 'string'},
'created': {
'description': 'Task creation time (UTC) ',
'format': 'date-time',
'type': 'string',
},
'name': {
'description': 'Task name Unique within the company.',
'type': 'string',
},
'output__error': {'description': 'Free text error', 'type': 'string'},
'project': {
'description': 'Project ID of the project to which this task is assigned',
'type': 'string',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'task': {'description': 'ID of the task', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
def __init__(
self, task, name=None, tags=None, comment=None, project=None, output__error=None, created=None, **kwargs):
super(UpdateRequest, self).__init__(**kwargs)
self.task = task
self.name = name
self.tags = tags
self.comment = comment
self.project = project
self.output__error = output__error
self.created = created
@schema_property('task')
def task(self):
return self._property_task
@task.setter
def task(self, value):
if value is None:
self._property_task = None
return
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('name')
def name(self):
return self._property_name
@name.setter
def name(self, value):
if value is None:
self._property_name = None
return
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('tags')
def tags(self):
return self._property_tags
@tags.setter
def tags(self, value):
if value is None:
self._property_tags = None
return
self.assert_isinstance(value, "tags", (list, tuple))
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('comment')
def comment(self):
return self._property_comment
@comment.setter
def comment(self, value):
if value is None:
self._property_comment = None
return
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = value
@schema_property('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
self.assert_isinstance(value, "project", six.string_types)
self._property_project = value
@schema_property('output__error')
def output__error(self):
return self._property_output__error
@output__error.setter
def output__error(self, value):
if value is None:
self._property_output__error = None
return
self.assert_isinstance(value, "output__error", six.string_types)
self._property_output__error = value
@schema_property('created')
def created(self):
return self._property_created
@created.setter
def created(self, value):
if value is None:
self._property_created = None
return
self.assert_isinstance(value, "created", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_created = value
class UpdateResponse(Response):
"""
Response of tasks.update endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "tasks"
_action = "update"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, fields=None, **kwargs):
super(UpdateResponse, self).__init__(**kwargs)
self.updated = updated
self.fields = fields
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
@schema_property('fields')
def fields(self):
return self._property_fields
@fields.setter
def fields(self, value):
if value is None:
self._property_fields = None
return
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class UpdateBatchRequest(BatchRequest):
"""
Updates a batch of tasks.
Headers
Content type should be 'application/json-lines'.
"""
_service = "tasks"
_action = "update_batch"
_version = "1.5"
_batched_request_cls = UpdateRequest
class UpdateBatchResponse(Response):
"""
Response of tasks.update_batch endpoint.
:param updated: Number of tasks updated (0 or 1)
:type updated: int
"""
_service = "tasks"
_action = "update_batch"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
def __init__(
self, updated=None, **kwargs):
super(UpdateBatchResponse, self).__init__(**kwargs)
self.updated = updated
@schema_property('updated')
def updated(self):
return self._property_updated
@updated.setter
def updated(self, value):
if value is None:
self._property_updated = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "updated", six.integer_types)
self._property_updated = value
class ValidateRequest(Request):
"""
Validate task properties (before create)
:param name: Task name. Unique within the company.
:type name: str
:param tags: Tags list
:type tags: Sequence[str]
:param type: Type of task
:type type: TaskTypeEnum
:param comment: Free text comment
:type comment: str
:param parent: Parent task id Must be a completed task.
:type parent: str
:param project: Project ID of the project to which this task is assigned Must
exist[ab]
:type project: str
:param output_dest: Output storage id Must be a reference to an existing
storage.
:type output_dest: str
:param execution: Task execution params
:type execution: Execution
:param script: Script info
:type script: Script
"""
_service = "tasks"
_action = "validate"
_version = "1.9"
_schema = {
'definitions': {
'execution': {
'properties': {
'framework': {
'description': 'Framework related to the task. Case insensitive. Mandatory for Training tasks. ',
'type': ['string', 'null'],
},
'model': {
'description': 'Execution input model ID Not applicable for Register (Import) tasks',
'type': ['string', 'null'],
},
'model_desc': {
'additionalProperties': True,
'description': 'Json object representing the Model descriptors',
'type': ['object', 'null'],
},
'model_labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model.\n The keys are the layers' names and the values are the IDs.\n Not applicable for Register (Import) tasks.\n Mandatory for Training tasks",
'type': ['object', 'null'],
},
'parameters': {
'additionalProperties': True,
'description': 'Json object containing the Task parameters',
'type': ['object', 'null'],
},
},
'type': 'object',
},
'script': {
'properties': {
'binary': {
'default': 'python',
'description': 'Binary to use when running the script',
'type': ['string', 'null'],
},
'branch': {
'description': 'Repository branch id If not provided and tag not provided, default repository branch is used.',
'type': ['string', 'null'],
},
'diff': {
'description': 'Uncommitted changes found in the repository when task was run',
'type': ['string', 'null'],
},
'entry_point': {
'description': 'Path to execute within the repository',
'type': ['string', 'null'],
},
'repository': {
'description': 'Name of the repository where the script is located',
'type': ['string', 'null'],
},
'requirements': {
'description': 'A JSON object containing requirements strings by key',
'type': ['object', 'null'],
},
'tag': {
'description': 'Repository tag',
'type': ['string', 'null'],
},
'version_num': {
'description': 'Version (changeset) number. Optional (default is head version) Unused if tag is provided.',
'type': ['string', 'null'],
},
'working_dir': {
'description': 'Path to the folder from which to run the script Default - root folder of repository',
'type': ['string', 'null'],
},
},
'type': 'object',
},
'task_type_enum': {'enum': ['training', 'testing'], 'type': 'string'},
},
'properties': {
'comment': {'description': 'Free text comment ', 'type': 'string'},
'execution': {
'$ref': '#/definitions/execution',
'description': 'Task execution params',
},
'name': {
'description': 'Task name. Unique within the company.',
'type': 'string',
},
'output_dest': {
'description': 'Output storage id Must be a reference to an existing storage.',
'type': 'string',
},
'parent': {
'description': 'Parent task id Must be a completed task.',
'type': 'string',
},
'project': {
'description': 'Project ID of the project to which this task is assigned Must exist[ab]',
'type': 'string',
},
'script': {
'$ref': '#/definitions/script',
'description': 'Script info',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'type': {
'$ref': '#/definitions/task_type_enum',
'description': 'Type of task',
},
},
'required': ['name', 'type'],
'type': 'object',
}
def __init__(
self, name, type, tags=None, comment=None, parent=None, project=None, output_dest=None, execution=None, script=None, **kwargs):
super(ValidateRequest, self).__init__(**kwargs)
self.name = name
self.tags = tags
self.type = type
self.comment = comment
self.parent = parent
self.project = project
self.output_dest = output_dest
self.execution = execution
self.script = script
@schema_property('name')
def name(self):
return self._property_name
@name.setter
def name(self, value):
if value is None:
self._property_name = None
return
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('tags')
def tags(self):
return self._property_tags
@tags.setter
def tags(self, value):
if value is None:
self._property_tags = None
return
self.assert_isinstance(value, "tags", (list, tuple))
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('type')
def type(self):
return self._property_type
@type.setter
def type(self, value):
if value is None:
self._property_type = None
return
if isinstance(value, six.string_types):
try:
value = TaskTypeEnum(value)
except ValueError:
pass
else:
self.assert_isinstance(value, "type", enum.Enum)
self._property_type = value
@schema_property('comment')
def comment(self):
return self._property_comment
@comment.setter
def comment(self, value):
if value is None:
self._property_comment = None
return
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = value
@schema_property('parent')
def parent(self):
return self._property_parent
@parent.setter
def parent(self, value):
if value is None:
self._property_parent = None
return
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = value
@schema_property('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
self.assert_isinstance(value, "project", six.string_types)
self._property_project = value
@schema_property('output_dest')
def output_dest(self):
return self._property_output_dest
@output_dest.setter
def output_dest(self, value):
if value is None:
self._property_output_dest = None
return
self.assert_isinstance(value, "output_dest", six.string_types)
self._property_output_dest = value
@schema_property('execution')
def execution(self):
return self._property_execution
@execution.setter
def execution(self, value):
if value is None:
self._property_execution = None
return
if isinstance(value, dict):
value = Execution.from_dict(value)
else:
self.assert_isinstance(value, "execution", Execution)
self._property_execution = value
@schema_property('script')
def script(self):
return self._property_script
@script.setter
def script(self, value):
if value is None:
self._property_script = None
return
if isinstance(value, dict):
value = Script.from_dict(value)
else:
self.assert_isinstance(value, "script", Script)
self._property_script = value
class ValidateResponse(Response):
"""
Response of tasks.validate endpoint.
"""
_service = "tasks"
_action = "validate"
_version = "1.9"
_schema = {'additionalProperties': False, 'definitions': {}, 'type': 'object'}
response_mapping = {
GetByIdRequest: GetByIdResponse,
GetAllRequest: GetAllResponse,
CreateRequest: CreateResponse,
ValidateRequest: ValidateResponse,
UpdateRequest: UpdateResponse,
UpdateBatchRequest: UpdateBatchResponse,
EditRequest: EditResponse,
ResetRequest: ResetResponse,
DeleteRequest: DeleteResponse,
StartedRequest: StartedResponse,
StopRequest: StopResponse,
StoppedRequest: StoppedResponse,
FailedRequest: FailedResponse,
CloseRequest: CloseResponse,
PublishRequest: PublishResponse,
SetRequirementsRequest: SetRequirementsResponse,
CompletedRequest: CompletedResponse,
PingRequest: PingResponse,
}