azure.cognitiveservices.vision.customvision.training.models.iteration.yml

### YamlMime:PythonClass
uid: azure.cognitiveservices.vision.customvision.training.models.Iteration
name: Iteration
fullName: azure.cognitiveservices.vision.customvision.training.models.Iteration
module: azure.cognitiveservices.vision.customvision.training.models
inheritances:
- msrest.serialization.Model
summary: '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.'
constructor:
  syntax: 'Iteration(*, name: str, **kwargs)'
  parameters:
  - name: name
    description: Required. Gets or sets the name of the iteration.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: name
    isRequired: true
variables:
- description: Gets the id of the iteration.
  name: id
  types:
  - <xref:str>
- description: Gets the current iteration status.
  name: status
  types:
  - <xref:str>
- description: Gets the time this iteration was completed.
  name: created
  types:
  - <xref:datetime>
- description: Gets the time this iteration was last modified.
  name: last_modified
  types:
  - <xref:datetime>
- description: Gets the time this iteration was last modified.
  name: trained_at
  types:
  - <xref:datetime>
- description: Gets the project id of the iteration.
  name: project_id
  types:
  - <xref:str>
- description: 'Whether the iteration can be exported to another format

    for download.'
  name: exportable
  types:
  - <xref:bool>
- description: A set of platforms this iteration can export to.
  name: exportable_to
  types:
  - <xref:list>[<xref:str>]
- description: 'Get or sets a guid of the domain the iteration has been

    trained on.'
  name: domain_id
  types:
  - <xref:str>
- description: 'Gets the classification type of the project.

    Possible values include: ''Multiclass'', ''Multilabel'''
  name: classification_type
  types:
  - <xref:str>
  - <xref:azure.cognitiveservices.vision.customvision.training.models.Classifier>
- description: 'Gets the training type of the iteration. Possible

    values include: ''Regular'', ''Advanced'''
  name: training_type
  types:
  - <xref:str>
  - <xref:azure.cognitiveservices.vision.customvision.training.models.TrainingType>
- description: 'Gets the reserved advanced training budget

    for the iteration.'
  name: reserved_budget_in_hours
  types:
  - <xref:int>
- description: Gets the training time for the iteration.
  name: training_time_in_minutes
  types:
  - <xref:int>
- description: Name of the published model.
  name: publish_name
  types:
  - <xref:str>
- description: 'Resource Provider Id this iteration

    was originally published to.'
  name: original_publish_resource_id
  types:
  - <xref:str>
- description: '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.'
  name: custom_base_model_info
  types:
  - <xref:azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo>
- description: 'Training error details, when training fails.

    Value is null when training succeeds.'
  name: training_error_details
  types:
  - <xref:str>
methods:
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.from_dict
  name: from_dict
  summary: '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)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.serialize
  name: serialize
  summary: '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.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>