ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-02-01 09:36:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c9fac89bcd
clearml/trains/backend_api/services/v2_1/models.py

2694 lines
82 KiB
Python
Raw Normal View History

Initial beta version
2019-06-10 17:00:28 +00:00
"""
models service
This service provides a management interface for models (results of training tasks) stored in the system.
"""
from datetime import datetime
flake8
2020-07-04 19:52:09 +00:00
import six
Initial beta version
2019-06-10 17:00:28 +00:00
from dateutil.parser import parse as parse_datetime
flake8
2020-07-04 19:52:09 +00:00
from ....backend_api.session import NonStrictDataModel, Request, Response, schema_property
Initial beta version
2019-06-10 17:00:28 +00:00
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',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "fields", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "fields", six.string_types, is_array=True)
self._property_fields = value
class Model(NonStrictDataModel):
"""
:param id: Model id
:type id: str
:param name: Model name
:type name: str
:param user: Associated user id
:type user: str
:param company: Company id
:type company: str
:param created: Model creation time
:type created: datetime.datetime
:param task: Task ID of task in which the model was created
:type task: str
:param parent: Parent model ID
:type parent: str
:param project: Associated project ID
:type project: str
:param comment: Model comment
:type comment: str
:param tags: Tags
:type tags: Sequence[str]
:param framework: Framework on which the model is based. Should be identical to
the framework of the task which created the model
:type framework: str
:param design: Json object representing the model design. Should be identical
to the network design of the task which created the model
:type design: dict
:param labels: Json object representing the ids of the labels in the model. The
keys are the layers' names and the values are the ids.
:type labels: dict
:param uri: URI for the model, pointing to the destination storage.
:type uri: str
:param ready: Indication if the model is final and can be used by other tasks
:type ready: bool
:param ui_cache: UI cache for this model
:type ui_cache: dict
"""
_schema = {
'properties': {
'comment': {'description': 'Model comment', 'type': ['string', 'null']},
'company': {'description': 'Company id', 'type': ['string', 'null']},
'created': {
'description': 'Model creation time',
'format': 'date-time',
'type': ['string', 'null'],
},
'design': {
'additionalProperties': True,
'description': 'Json object representing the model design. Should be identical to the network design of the task which created the model',
'type': ['object', 'null'],
},
'framework': {
'description': 'Framework on which the model is based. Should be identical to the framework of the task which created the model',
'type': ['string', 'null'],
},
'id': {'description': 'Model id', 'type': ['string', 'null']},
'labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the ids.",
'type': ['object', 'null'],
},
'name': {'description': 'Model name', 'type': ['string', 'null']},
'parent': {
'description': 'Parent model ID',
'type': ['string', 'null'],
},
'project': {
'description': 'Associated project ID',
'type': ['string', 'null'],
},
'ready': {
'description': 'Indication if the model is final and can be used by other tasks',
'type': ['boolean', 'null'],
},
'tags': {
'description': 'Tags',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'task': {
'description': 'Task ID of task in which the model was created',
'type': ['string', 'null'],
},
'ui_cache': {
'additionalProperties': True,
'description': 'UI cache for this model',
'type': ['object', 'null'],
},
'uri': {
'description': 'URI for the model, pointing to the destination storage.',
'type': ['string', 'null'],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, id=None, name=None, user=None, company=None, created=None, task=None, parent=None, project=None, comment=None, tags=None, framework=None, design=None, labels=None, uri=None, ready=None, ui_cache=None, **kwargs):
super(Model, self).__init__(**kwargs)
self.id = id
self.name = name
self.user = user
self.company = company
self.created = created
self.task = task
self.parent = parent
self.project = project
self.comment = comment
self.tags = tags
self.framework = framework
self.design = design
self.labels = labels
self.uri = uri
self.ready = ready
self.ui_cache = ui_cache
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "company", six.string_types)
self._property_company = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "created", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_created = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types)
self._property_task = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "project", six.string_types)
self._property_project = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "framework", six.string_types)
self._property_framework = value
@schema_property('design')
def design(self):
return self._property_design
@design.setter
def design(self, value):
if value is None:
self._property_design = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "design", (dict,))
self._property_design = value
@schema_property('labels')
def labels(self):
return self._property_labels
@labels.setter
def labels(self, value):
if value is None:
self._property_labels = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "labels", (dict,))
self._property_labels = value
@schema_property('uri')
def uri(self):
return self._property_uri
@uri.setter
def uri(self, value):
if value is None:
self._property_uri = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "uri", six.string_types)
self._property_uri = value
@schema_property('ready')
def ready(self):
return self._property_ready
@ready.setter
def ready(self, value):
if value is None:
self._property_ready = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ready", (bool,))
self._property_ready = value
@schema_property('ui_cache')
def ui_cache(self):
return self._property_ui_cache
@ui_cache.setter
def ui_cache(self, value):
if value is None:
self._property_ui_cache = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ui_cache", (dict,))
self._property_ui_cache = value
class CreateRequest(Request):
"""
Create a new model not associated with a task
:param uri: URI for the model
:type uri: str
:param name: Model name Unique within the company.
:type name: str
:param comment: Model comment
:type comment: str
:param tags: Tags list
:type tags: Sequence[str]
:param framework: Framework on which the model is based. Case insensitive.
Should be identical to the framework of the task which created the model.
:type framework: str
:param design: Json[d] object representing the model design. Should be
identical to the network design of the task which created the model
:type design: dict
:param labels: Json object
:type labels: dict
:param ready: Indication if the model is final and can be used by other tasks
Default is false.
:type ready: bool
:param public: Create a public model Default is false.
:type public: bool
:param project: Project to which to model belongs
:type project: str
:param parent: Parent model
:type parent: str
:param task: Associated task ID
:type task: str
"""
_service = "models"
_action = "create"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'comment': {'description': 'Model comment', 'type': 'string'},
'design': {
'additionalProperties': True,
'description': 'Json[d] object representing the model design. Should be identical to the network design of the task which created the model',
'type': 'object',
},
'framework': {
'description': 'Framework on which the model is based. Case insensitive. Should be identical to the framework of the task which created the model.',
'type': 'string',
},
'labels': {
'additionalProperties': {'type': 'integer'},
'description': 'Json object',
'type': 'object',
},
'name': {
'description': 'Model name Unique within the company.',
'type': 'string',
},
'parent': {'description': 'Parent model', 'type': 'string'},
'project': {
'description': 'Project to which to model belongs',
'type': 'string',
},
'public': {
'default': False,
'description': 'Create a public model Default is false.',
'type': 'boolean',
},
'ready': {
'default': False,
'description': 'Indication if the model is final and can be used by other tasks Default is false.',
'type': 'boolean',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'task': {'description': 'Associated task ID', 'type': 'string'},
'uri': {'description': 'URI for the model', 'type': 'string'},
},
'required': ['uri', 'name', 'labels'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, uri, name, labels, comment=None, tags=None, framework=None, design=None, ready=False, public=False, project=None, parent=None, task=None, **kwargs):
super(CreateRequest, self).__init__(**kwargs)
self.uri = uri
self.name = name
self.comment = comment
self.tags = tags
self.framework = framework
self.design = design
self.labels = labels
self.ready = ready
self.public = public
self.project = project
self.parent = parent
self.task = task
@schema_property('uri')
def uri(self):
return self._property_uri
@uri.setter
def uri(self, value):
if value is None:
self._property_uri = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "uri", six.string_types)
self._property_uri = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "name", six.string_types)
self._property_name = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "framework", six.string_types)
self._property_framework = value
@schema_property('design')
def design(self):
return self._property_design
@design.setter
def design(self, value):
if value is None:
self._property_design = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "design", (dict,))
self._property_design = value
@schema_property('labels')
def labels(self):
return self._property_labels
@labels.setter
def labels(self, value):
if value is None:
self._property_labels = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "labels", (dict,))
self._property_labels = value
@schema_property('ready')
def ready(self):
return self._property_ready
@ready.setter
def ready(self, value):
if value is None:
self._property_ready = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ready", (bool,))
self._property_ready = value
@schema_property('public')
def public(self):
return self._property_public
@public.setter
def public(self, value):
if value is None:
self._property_public = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "public", (bool,))
self._property_public = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "project", six.string_types)
self._property_project = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
class CreateResponse(Response):
"""
Response of models.create endpoint.
:param id: ID of the model
:type id: str
:param created: Was the model created
:type created: bool
"""
_service = "models"
_action = "create"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'created': {
'description': 'Was the model created',
'type': ['boolean', 'null'],
},
'id': {'description': 'ID of the model', 'type': ['string', 'null']},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, id=None, created=None, **kwargs):
super(CreateResponse, self).__init__(**kwargs)
self.id = id
self.created = created
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "id", six.string_types)
self._property_id = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "created", (bool,))
self._property_created = value
class DeleteRequest(Request):
"""
Delete a model.
:param model: Model ID
:type model: str
:param force: Force. Required if there are tasks that use the model as an
execution model, or if the model's creating task is published.
:type force: bool
"""
_service = "models"
_action = "delete"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'force': {
'description': "Force. Required if there are tasks that use the model as an execution model, or if the model's creating task is published.\n ",
'type': 'boolean',
},
'model': {'description': 'Model ID', 'type': 'string'},
},
'required': ['model'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model, force=None, **kwargs):
super(DeleteRequest, self).__init__(**kwargs)
self.model = model
self.force = force
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "model", six.string_types)
self._property_model = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "force", (bool,))
self._property_force = value
class DeleteResponse(Response):
"""
Response of models.delete endpoint.
:param deleted: Indicates whether the model was deleted
:type deleted: bool
"""
_service = "models"
_action = "delete"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'deleted': {
'description': 'Indicates whether the model was deleted',
'type': ['boolean', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, deleted=None, **kwargs):
super(DeleteResponse, self).__init__(**kwargs)
self.deleted = deleted
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "deleted", (bool,))
self._property_deleted = value
class EditRequest(Request):
"""
Edit an existing model
:param model: Model ID
:type model: str
:param uri: URI for the model
:type uri: str
:param name: Model name Unique within the company.
:type name: str
:param comment: Model comment
:type comment: str
:param tags: Tags list
:type tags: Sequence[str]
:param framework: Framework on which the model is based. Case insensitive.
Should be identical to the framework of the task which created the model.
:type framework: str
:param design: Json[d] object representing the model design. Should be
identical to the network design of the task which created the model
:type design: dict
:param labels: Json object
:type labels: dict
:param ready: Indication if the model is final and can be used by other tasks
:type ready: bool
:param project: Project to which to model belongs
:type project: str
:param parent: Parent model
:type parent: str
:param task: Associated task ID
:type task: str
:param iteration: Iteration (used to update task statistics)
:type iteration: int
"""
_service = "models"
_action = "edit"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'comment': {'description': 'Model comment', 'type': 'string'},
'design': {
'additionalProperties': True,
'description': 'Json[d] object representing the model design. Should be identical to the network design of the task which created the model',
'type': 'object',
},
'framework': {
'description': 'Framework on which the model is based. Case insensitive. Should be identical to the framework of the task which created the model.',
'type': 'string',
},
'iteration': {
'description': 'Iteration (used to update task statistics)',
'type': 'integer',
},
'labels': {
'additionalProperties': {'type': 'integer'},
'description': 'Json object',
'type': 'object',
},
'model': {'description': 'Model ID', 'type': 'string'},
'name': {
'description': 'Model name Unique within the company.',
'type': 'string',
},
'parent': {'description': 'Parent model', 'type': 'string'},
'project': {
'description': 'Project to which to model belongs',
'type': 'string',
},
'ready': {
'description': 'Indication if the model is final and can be used by other tasks',
'type': 'boolean',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'task': {'description': 'Associated task ID', 'type': 'string'},
'uri': {'description': 'URI for the model', 'type': 'string'},
},
'required': ['model'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model, uri=None, name=None, comment=None, tags=None, framework=None, design=None, labels=None, ready=None, project=None, parent=None, task=None, iteration=None, **kwargs):
super(EditRequest, self).__init__(**kwargs)
self.model = model
self.uri = uri
self.name = name
self.comment = comment
self.tags = tags
self.framework = framework
self.design = design
self.labels = labels
self.ready = ready
self.project = project
self.parent = parent
self.task = task
self.iteration = iteration
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "model", six.string_types)
self._property_model = value
@schema_property('uri')
def uri(self):
return self._property_uri
@uri.setter
def uri(self, value):
if value is None:
self._property_uri = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "uri", six.string_types)
self._property_uri = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "name", six.string_types)
self._property_name = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "framework", six.string_types)
self._property_framework = value
@schema_property('design')
def design(self):
return self._property_design
@design.setter
def design(self, value):
if value is None:
self._property_design = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "design", (dict,))
self._property_design = value
@schema_property('labels')
def labels(self):
return self._property_labels
@labels.setter
def labels(self, value):
if value is None:
self._property_labels = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "labels", (dict,))
self._property_labels = value
@schema_property('ready')
def ready(self):
return self._property_ready
@ready.setter
def ready(self, value):
if value is None:
self._property_ready = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ready", (bool,))
self._property_ready = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "project", six.string_types)
self._property_project = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "parent", six.string_types)
self._property_parent = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('iteration')
def iteration(self):
return self._property_iteration
@iteration.setter
def iteration(self, value):
if value is None:
self._property_iteration = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "iteration", six.integer_types)
self._property_iteration = value
class EditResponse(Response):
"""
Response of models.edit endpoint.
:param updated: Number of models updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "models"
_action = "edit"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of models updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class GetAllRequest(Request):
"""
Get all models
:param name: Get only models whose name matches this pattern (python regular
expression syntax)
:type name: str
:param ready: Indication whether to retrieve only models that are marked ready
If not supplied returns both ready and not-ready projects.
:type ready: bool
:param tags: Tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
:type tags: Sequence[str]
:param only_fields: List of model field names (if applicable, nesting is
supported using '.'). 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 page: Page number, returns a specific page out of the resulting list of
models
: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 project: List of associated project IDs
:type project: Sequence[str]
: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 task: List of associated task IDs
:type task: Sequence[str]
:param id: List of model IDs
:type id: Sequence[str]
:param search_text: Free text search query
:type search_text: str
:param framework: List of frameworks
:type framework: Sequence[str]
:param uri: List of model URIs
:type uri: Sequence[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 = "models"
_action = "get_all"
_version = "1.5"
_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',
},
},
'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'},
],
},
'framework': {
'description': 'List of frameworks',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'id': {
'description': 'List of model IDs',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'name': {
'description': 'Get only models whose name matches this pattern (python regular expression syntax)',
'type': ['string', 'null'],
},
'only_fields': {
'description': "List of model field names (if applicable, nesting is supported using '.'). 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 models',
'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'],
},
'project': {
'description': 'List of associated project IDs',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'ready': {
'description': 'Indication whether to retrieve only models that are marked ready If not supplied returns both ready and not-ready projects.',
'type': ['boolean', 'null'],
},
'search_text': {
'description': 'Free text search query',
'type': ['string', 'null'],
},
'tags': {
'description': "Tags list used to filter results. Prepend '-' to tag name to indicate exclusion",
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'task': {
'description': 'List of associated task IDs',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'uri': {
'description': 'List of model URIs',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, name=None, ready=None, tags=None, only_fields=None, page=None, page_size=None, project=None, order_by=None, task=None, id=None, search_text=None, framework=None, uri=None, _all_=None, _any_=None, **kwargs):
super(GetAllRequest, self).__init__(**kwargs)
self.name = name
self.ready = ready
self.tags = tags
self.only_fields = only_fields
self.page = page
self.page_size = page_size
self.project = project
self.order_by = order_by
self.task = task
self.id = id
self.search_text = search_text
self.framework = framework
self.uri = uri
self._all_ = _all_
self._any_ = _any_
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "name", six.string_types)
self._property_name = value
@schema_property('ready')
def ready(self):
return self._property_ready
@ready.setter
def ready(self, value):
if value is None:
self._property_ready = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ready", (bool,))
self._property_ready = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "only_fields", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "only_fields", six.string_types, is_array=True)
self._property_only_fields = 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('project')
def project(self):
return self._property_project
@project.setter
def project(self, value):
if value is None:
self._property_project = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "project", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "project", six.string_types, is_array=True)
self._property_project = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "order_by", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "order_by", six.string_types, is_array=True)
self._property_order_by = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types, is_array=True)
self._property_task = value
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "id", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "id", six.string_types, is_array=True)
self._property_id = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "search_text", six.string_types)
self._property_search_text = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "framework", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "framework", six.string_types, is_array=True)
self._property_framework = value
@schema_property('uri')
def uri(self):
return self._property_uri
@uri.setter
def uri(self, value):
if value is None:
self._property_uri = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "uri", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "uri", six.string_types, is_array=True)
self._property_uri = 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 models.get_all endpoint.
:param models: Models list
:type models: Sequence[Model]
"""
_service = "models"
_action = "get_all"
_version = "1.5"
_schema = {
'definitions': {
'model': {
'properties': {
'comment': {
'description': 'Model comment',
'type': ['string', 'null'],
},
'company': {
'description': 'Company id',
'type': ['string', 'null'],
},
'created': {
'description': 'Model creation time',
'format': 'date-time',
'type': ['string', 'null'],
},
'design': {
'additionalProperties': True,
'description': 'Json object representing the model design. Should be identical to the network design of the task which created the model',
'type': ['object', 'null'],
},
'framework': {
'description': 'Framework on which the model is based. Should be identical to the framework of the task which created the model',
'type': ['string', 'null'],
},
'id': {'description': 'Model id', 'type': ['string', 'null']},
'labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the ids.",
'type': ['object', 'null'],
},
'name': {
'description': 'Model name',
'type': ['string', 'null'],
},
'parent': {
'description': 'Parent model ID',
'type': ['string', 'null'],
},
'project': {
'description': 'Associated project ID',
'type': ['string', 'null'],
},
'ready': {
'description': 'Indication if the model is final and can be used by other tasks',
'type': ['boolean', 'null'],
},
'tags': {
'description': 'Tags',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'task': {
'description': 'Task ID of task in which the model was created',
'type': ['string', 'null'],
},
'ui_cache': {
'additionalProperties': True,
'description': 'UI cache for this model',
'type': ['object', 'null'],
},
'uri': {
'description': 'URI for the model, pointing to the destination storage.',
'type': ['string', 'null'],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
},
},
'properties': {
'models': {
'description': 'Models list',
'items': {'$ref': '#/definitions/model'},
'type': ['array', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, models=None, **kwargs):
super(GetAllResponse, self).__init__(**kwargs)
self.models = models
@schema_property('models')
def models(self):
return self._property_models
@models.setter
def models(self, value):
if value is None:
self._property_models = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "models", (list, tuple))
if any(isinstance(v, dict) for v in value):
value = [Model.from_dict(v) if isinstance(v, dict) else v for v in value]
else:
self.assert_isinstance(value, "models", Model, is_array=True)
self._property_models = value
class GetByIdRequest(Request):
"""
Gets model information
:param model: Model id
:type model: str
"""
_service = "models"
_action = "get_by_id"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {'model': {'description': 'Model id', 'type': 'string'}},
'required': ['model'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model, **kwargs):
super(GetByIdRequest, self).__init__(**kwargs)
self.model = model
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "model", six.string_types)
self._property_model = value
class GetByIdResponse(Response):
"""
Response of models.get_by_id endpoint.
:param model: Model info
:type model: Model
"""
_service = "models"
_action = "get_by_id"
_version = "1.5"
_schema = {
'definitions': {
'model': {
'properties': {
'comment': {
'description': 'Model comment',
'type': ['string', 'null'],
},
'company': {
'description': 'Company id',
'type': ['string', 'null'],
},
'created': {
'description': 'Model creation time',
'format': 'date-time',
'type': ['string', 'null'],
},
'design': {
'additionalProperties': True,
'description': 'Json object representing the model design. Should be identical to the network design of the task which created the model',
'type': ['object', 'null'],
},
'framework': {
'description': 'Framework on which the model is based. Should be identical to the framework of the task which created the model',
'type': ['string', 'null'],
},
'id': {'description': 'Model id', 'type': ['string', 'null']},
'labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the ids.",
'type': ['object', 'null'],
},
'name': {
'description': 'Model name',
'type': ['string', 'null'],
},
'parent': {
'description': 'Parent model ID',
'type': ['string', 'null'],
},
'project': {
'description': 'Associated project ID',
'type': ['string', 'null'],
},
'ready': {
'description': 'Indication if the model is final and can be used by other tasks',
'type': ['boolean', 'null'],
},
'tags': {
'description': 'Tags',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'task': {
'description': 'Task ID of task in which the model was created',
'type': ['string', 'null'],
},
'ui_cache': {
'additionalProperties': True,
'description': 'UI cache for this model',
'type': ['object', 'null'],
},
'uri': {
'description': 'URI for the model, pointing to the destination storage.',
'type': ['string', 'null'],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
},
},
'properties': {
'model': {
'description': 'Model info',
'oneOf': [{'$ref': '#/definitions/model'}, {'type': 'null'}],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model=None, **kwargs):
super(GetByIdResponse, self).__init__(**kwargs)
self.model = model
@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
if isinstance(value, dict):
value = Model.from_dict(value)
else:
self.assert_isinstance(value, "model", Model)
self._property_model = value
class GetByTaskIdRequest(Request):
"""
Gets model information
:param task: Task id
:type task: str
"""
_service = "models"
_action = "get_by_task_id"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'task': {'description': 'Task id', 'type': ['string', 'null']},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, task=None, **kwargs):
super(GetByTaskIdRequest, 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
class GetByTaskIdResponse(Response):
"""
Response of models.get_by_task_id endpoint.
:param model: Model info
:type model: Model
"""
_service = "models"
_action = "get_by_task_id"
_version = "1.5"
_schema = {
'definitions': {
'model': {
'properties': {
'comment': {
'description': 'Model comment',
'type': ['string', 'null'],
},
'company': {
'description': 'Company id',
'type': ['string', 'null'],
},
'created': {
'description': 'Model creation time',
'format': 'date-time',
'type': ['string', 'null'],
},
'design': {
'additionalProperties': True,
'description': 'Json object representing the model design. Should be identical to the network design of the task which created the model',
'type': ['object', 'null'],
},
'framework': {
'description': 'Framework on which the model is based. Should be identical to the framework of the task which created the model',
'type': ['string', 'null'],
},
'id': {'description': 'Model id', 'type': ['string', 'null']},
'labels': {
'additionalProperties': {'type': 'integer'},
'description': "Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the ids.",
'type': ['object', 'null'],
},
'name': {
'description': 'Model name',
'type': ['string', 'null'],
},
'parent': {
'description': 'Parent model ID',
'type': ['string', 'null'],
},
'project': {
'description': 'Associated project ID',
'type': ['string', 'null'],
},
'ready': {
'description': 'Indication if the model is final and can be used by other tasks',
'type': ['boolean', 'null'],
},
'tags': {
'description': 'Tags',
'items': {'type': 'string'},
'type': ['array', 'null'],
},
'task': {
'description': 'Task ID of task in which the model was created',
'type': ['string', 'null'],
},
'ui_cache': {
'additionalProperties': True,
'description': 'UI cache for this model',
'type': ['object', 'null'],
},
'uri': {
'description': 'URI for the model, pointing to the destination storage.',
'type': ['string', 'null'],
},
'user': {
'description': 'Associated user id',
'type': ['string', 'null'],
},
},
'type': 'object',
},
},
'properties': {
'model': {
'description': 'Model info',
'oneOf': [{'$ref': '#/definitions/model'}, {'type': 'null'}],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model=None, **kwargs):
super(GetByTaskIdResponse, self).__init__(**kwargs)
self.model = model
@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
if isinstance(value, dict):
value = Model.from_dict(value)
else:
self.assert_isinstance(value, "model", Model)
self._property_model = value
class SetReadyRequest(Request):
"""
Set the model ready flag to True. If the model is an output model of a task then try to publish the task.
:param model: Model id
:type model: str
:param force_publish_task: Publish the associated task (if exists) even if it
is not in the 'stopped' state. Optional, the default value is False.
:type force_publish_task: bool
:param publish_task: Indicates that the associated task (if exists) should be
published. Optional, the default value is True.
:type publish_task: bool
"""
_service = "models"
_action = "set_ready"
_version = "1.9"
_schema = {
'definitions': {},
'properties': {
'force_publish_task': {
'description': "Publish the associated task (if exists) even if it is not in the 'stopped' state. Optional, the default value is False.",
'type': 'boolean',
},
'model': {'description': 'Model id', 'type': 'string'},
'publish_task': {
'description': 'Indicates that the associated task (if exists) should be published. Optional, the default value is True.',
'type': 'boolean',
},
},
'required': ['model'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model, force_publish_task=None, publish_task=None, **kwargs):
super(SetReadyRequest, self).__init__(**kwargs)
self.model = model
self.force_publish_task = force_publish_task
self.publish_task = publish_task
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "model", six.string_types)
self._property_model = value
@schema_property('force_publish_task')
def force_publish_task(self):
return self._property_force_publish_task
@force_publish_task.setter
def force_publish_task(self, value):
if value is None:
self._property_force_publish_task = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "force_publish_task", (bool,))
self._property_force_publish_task = value
@schema_property('publish_task')
def publish_task(self):
return self._property_publish_task
@publish_task.setter
def publish_task(self, value):
if value is None:
self._property_publish_task = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "publish_task", (bool,))
self._property_publish_task = value
class SetReadyResponse(Response):
"""
Response of models.set_ready endpoint.
:param updated: Number of models updated (0 or 1)
:type updated: int
:param published_task: Result of publishing of the model's associated task (if
exists). Returned only if the task was published successfully as part of the
model publishing.
:type published_task: dict
"""
_service = "models"
_action = "set_ready"
_version = "1.9"
_schema = {
'definitions': {},
'properties': {
'published_task': {
'description': "Result of publishing of the model's associated task (if exists). Returned only if the task was published successfully as part of the model publishing.",
'properties': {
'data': {
'description': 'Data returned from the task publishing operation.',
'properties': {
'committed_versions_results': {
'description': 'Committed versions results',
'items': {
'additionalProperties': True,
'type': 'object',
},
'type': 'array',
},
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': 'object',
},
'updated': {
'description': 'Number of tasks updated (0 or 1)',
'enum': [0, 1],
'type': 'integer',
},
},
'type': 'object',
},
'id': {'description': 'Task id', 'type': 'string'},
},
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of models updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, updated=None, published_task=None, **kwargs):
super(SetReadyResponse, self).__init__(**kwargs)
self.updated = updated
self.published_task = published_task
@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('published_task')
def published_task(self):
return self._property_published_task
@published_task.setter
def published_task(self, value):
if value is None:
self._property_published_task = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "published_task", (dict,))
self._property_published_task = value
class UpdateRequest(Request):
"""
Update a model
:param model: Model id
:type model: str
:param name: Model name Unique within the company.
:type name: str
:param comment: Model comment
:type comment: str
:param tags: Tags list
:type tags: Sequence[str]
:param ready: Indication if the model is final and can be used by other tasks
Default is false.
:type ready: bool
:param created: Model creation time (UTC)
:type created: datetime.datetime
:param ui_cache: UI cache for this model
:type ui_cache: dict
:param project: Project to which to model belongs
:type project: str
:param task: Associated task ID
:type task: str
:param iteration: Iteration (used to update task statistics if an associated
task is reported)
:type iteration: int
"""
_service = "models"
_action = "update"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'comment': {'description': 'Model comment', 'type': 'string'},
'created': {
'description': 'Model creation time (UTC) ',
'format': 'date-time',
'type': 'string',
},
'iteration': {
'description': 'Iteration (used to update task statistics if an associated task is reported)',
'type': 'integer',
},
'model': {'description': 'Model id', 'type': 'string'},
'name': {
'description': 'Model name Unique within the company.',
'type': 'string',
},
'project': {
'description': 'Project to which to model belongs',
'type': 'string',
},
'ready': {
'default': False,
'description': 'Indication if the model is final and can be used by other tasks Default is false.',
'type': 'boolean',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'task': {'description': 'Associated task ID', 'type': 'string'},
'ui_cache': {
'additionalProperties': True,
'description': 'UI cache for this model',
'type': 'object',
},
},
'required': ['model'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, model, name=None, comment=None, tags=None, ready=False, created=None, ui_cache=None, project=None, task=None, iteration=None, **kwargs):
super(UpdateRequest, self).__init__(**kwargs)
self.model = model
self.name = name
self.comment = comment
self.tags = tags
self.ready = ready
self.created = created
self.ui_cache = ui_cache
self.project = project
self.task = task
self.iteration = iteration
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "model", six.string_types)
self._property_model = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "name", six.string_types)
self._property_name = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('ready')
def ready(self):
return self._property_ready
@ready.setter
def ready(self, value):
if value is None:
self._property_ready = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ready", (bool,))
self._property_ready = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "created", six.string_types + (datetime,))
if not isinstance(value, datetime):
value = parse_datetime(value)
self._property_created = value
@schema_property('ui_cache')
def ui_cache(self):
return self._property_ui_cache
@ui_cache.setter
def ui_cache(self, value):
if value is None:
self._property_ui_cache = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "ui_cache", (dict,))
self._property_ui_cache = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "project", six.string_types)
self._property_project = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('iteration')
def iteration(self):
return self._property_iteration
@iteration.setter
def iteration(self, value):
if value is None:
self._property_iteration = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "iteration", six.integer_types)
self._property_iteration = value
class UpdateResponse(Response):
"""
Response of models.update endpoint.
:param updated: Number of models updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "models"
_action = "update"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'updated': {
'description': 'Number of models updated (0 or 1)',
'enum': [0, 1],
'type': ['integer', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
class UpdateForTaskRequest(Request):
"""
Create or update a new model for a task
:param task: Task id
:type task: str
:param uri: URI for the model
:type uri: str
:param name: Model name Unique within the company.
:type name: str
:param comment: Model comment
:type comment: str
:param tags: Tags list
:type tags: Sequence[str]
:param override_model_id: Override model ID. If provided, this model is updated
in the task.
:type override_model_id: str
:param iteration: Iteration (used to update task statistics)
:type iteration: int
"""
_service = "models"
_action = "update_for_task"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'comment': {'description': 'Model comment', 'type': 'string'},
'iteration': {
'description': 'Iteration (used to update task statistics)',
'type': 'integer',
},
'name': {
'description': 'Model name Unique within the company.',
'type': 'string',
},
'override_model_id': {
'description': 'Override model ID. If provided, this model is updated in the task.',
'type': 'string',
},
'tags': {'description': 'Tags list', 'items': {'type': 'string'}, 'type': 'array'},
'task': {'description': 'Task id', 'type': 'string'},
'uri': {'description': 'URI for the model', 'type': 'string'},
},
'required': ['task'],
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, task, uri=None, name=None, comment=None, tags=None, override_model_id=None, iteration=None, **kwargs):
super(UpdateForTaskRequest, self).__init__(**kwargs)
self.task = task
self.uri = uri
self.name = name
self.comment = comment
self.tags = tags
self.override_model_id = override_model_id
self.iteration = iteration
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "task", six.string_types)
self._property_task = value
@schema_property('uri')
def uri(self):
return self._property_uri
@uri.setter
def uri(self, value):
if value is None:
self._property_uri = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "uri", six.string_types)
self._property_uri = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "name", six.string_types)
self._property_name = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "comment", six.string_types)
self._property_comment = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", (list, tuple))
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "tags", six.string_types, is_array=True)
self._property_tags = value
@schema_property('override_model_id')
def override_model_id(self):
return self._property_override_model_id
@override_model_id.setter
def override_model_id(self, value):
if value is None:
self._property_override_model_id = None
return
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "override_model_id", six.string_types)
self._property_override_model_id = value
@schema_property('iteration')
def iteration(self):
return self._property_iteration
@iteration.setter
def iteration(self, value):
if value is None:
self._property_iteration = None
return
if isinstance(value, float) and value.is_integer():
value = int(value)
self.assert_isinstance(value, "iteration", six.integer_types)
self._property_iteration = value
class UpdateForTaskResponse(Response):
"""
Response of models.update_for_task endpoint.
:param id: ID of the model
:type id: str
:param created: Was the model created
:type created: bool
:param updated: Number of models updated (0 or 1)
:type updated: int
:param fields: Updated fields names and values
:type fields: dict
"""
_service = "models"
_action = "update_for_task"
_version = "1.5"
_schema = {
'definitions': {},
'properties': {
'created': {
'description': 'Was the model created',
'type': ['boolean', 'null'],
},
'fields': {
'additionalProperties': True,
'description': 'Updated fields names and values',
'type': ['object', 'null'],
},
'id': {'description': 'ID of the model', 'type': ['string', 'null']},
'updated': {
'description': 'Number of models updated (0 or 1)',
'type': ['integer', 'null'],
},
},
'type': 'object',
}
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
def __init__(
self, id=None, created=None, updated=None, fields=None, **kwargs):
super(UpdateForTaskResponse, self).__init__(**kwargs)
self.id = id
self.created = created
self.updated = updated
self.fields = fields
@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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "id", six.string_types)
self._property_id = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "created", (bool,))
self._property_created = 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
flake8
2020-07-04 19:52:09 +00:00
Initial beta version
2019-06-10 17:00:28 +00:00
self.assert_isinstance(value, "fields", (dict,))
self._property_fields = value
response_mapping = {
GetByIdRequest: GetByIdResponse,
GetByTaskIdRequest: GetByTaskIdResponse,
GetAllRequest: GetAllResponse,
UpdateForTaskRequest: UpdateForTaskResponse,
CreateRequest: CreateResponse,
EditRequest: EditResponse,
UpdateRequest: UpdateResponse,
SetReadyRequest: SetReadyResponse,
DeleteRequest: DeleteResponse,
}
Reference in New Issue Copy Permalink