Iteration Class

Iteration model to be sent over JSON.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

msrest.serialization.Model

Iteration

Constructor

Iteration(*, name: str, **kwargs)

Parameters

Name	Description
name Required	str Required. Gets or sets the name of the iteration.

Keyword-Only Parameters

Name	Description
name Required

Variables

Name	Description
id	str Gets the id of the iteration.
status	str Gets the current iteration status.
created	datetime Gets the time this iteration was completed.
last_modified	datetime Gets the time this iteration was last modified.
trained_at	datetime Gets the time this iteration was last modified.
project_id	str Gets the project id of the iteration.
exportable	bool Whether the iteration can be exported to another format for download.
exportable_to	list[str] A set of platforms this iteration can export to.
domain_id	str Get or sets a guid of the domain the iteration has been trained on.
classification_type	str or Classifier Gets the classification type of the project. Possible values include: 'Multiclass', 'Multilabel'
training_type	str or TrainingType Gets the training type of the iteration. Possible values include: 'Regular', 'Advanced'
reserved_budget_in_hours	int Gets the reserved advanced training budget for the iteration.
training_time_in_minutes	int Gets the training time for the iteration.
publish_name	str Name of the published model.
original_publish_resource_id	str Resource Provider Id this iteration was originally published to.
custom_base_model_info	CustomBaseModelInfo Information of the previously trained iteration which provides the base model for current iteration's training. Default value of null specifies that no previously trained iteration will be used for incremental learning.
training_error_details	str Training error details, when training fails. Value is null when training succeeds.

Methods

as_dict	Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.
validate	Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. default value: None
key_extractors	default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error