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

### YamlMime:PythonClass
uid: azure.cognitiveservices.vision.customvision.training.models.Domain
name: Domain
fullName: azure.cognitiveservices.vision.customvision.training.models.Domain
module: azure.cognitiveservices.vision.customvision.training.models
inheritances:
- msrest.serialization.Model
summary: 'Domains are used as the starting point for your project. Each domain is

  optimized for specific types of images. Domains with compact in their name

  can be exported. For more information visit the <a

  href="[https://go.microsoft.com/fwlink/?linkid=2117014](https://go.microsoft.com/fwlink/?linkid=2117014)">domain

  documentation</a>.


  Variables are only populated by the server, and will be ignored when

  sending a request.'
constructor:
  syntax: Domain(**kwargs)
variables:
- description: Domain id.
  name: id
  types:
  - <xref:str>
- description: 'Name of the domain, describing the types of images used to

    train it.'
  name: name
  types:
  - <xref:str>
- description: 'Domain type: Classification or ObjectDetection. Possible

    values include: ''Classification'', ''ObjectDetection'''
  name: type
  types:
  - <xref:str>
  - <xref:azure.cognitiveservices.vision.customvision.training.models.DomainType>
- description: Indicating if the domain is exportable.
  name: exportable
  types:
  - <xref:bool>
- description: Indicating if the domain is enabled.
  name: enabled
  types:
  - <xref:bool>
- description: Platforms that the domain can be exported to.
  name: exportable_platforms
  types:
  - <xref:list>[<xref:str>]
- description: Model information.
  name: model_information
  types:
  - <xref:azure.cognitiveservices.vision.customvision.training.models.ModelInformation>
methods:
- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.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.Domain.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.Domain.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.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.Domain.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.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.Domain.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>