azure.cognitiveservices.vision.customvision.training.models module¶
-
class
azure.cognitiveservices.vision.customvision.training.models.
Domain
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Domain.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) –
- name (str) –
- type (str or DomainType) – Possible values include: ‘Classification’, ‘ObjectDetection’
- exportable (bool) –
- enabled (bool) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageTag
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageTag.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - tag_id (str) –
- tag_name (str) –
- created (datetime) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageRegion
(*, tag_id: str = None, left: float = None, top: float = None, width: float = None, height: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageRegion.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - region_id (str) –
- tag_name (str) –
- created (datetime) –
Parameters: - tag_id (str) –
- left (float) –
- top (float) –
- width (float) –
- height (float) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
Image
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Image model to be sent as JSON.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) –
- created (datetime) –
- width (int) –
- height (int) –
- image_uri (str) –
- thumbnail_uri (str) –
- tags (list[ImageTag]) –
- regions (list[ImageRegion]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageCreateResult
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageCreateResult.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - source_url (str) –
- status (str or ImageUploadStatus) – Possible values include: ‘OK’, ‘OKDuplicate’, ‘ErrorSource’, ‘ErrorImageFormat’, ‘ErrorImageSize’, ‘ErrorStorage’, ‘ErrorLimitExceed’, ‘ErrorTagLimitExceed’, ‘ErrorRegionLimitExceed’, ‘ErrorUnknown’
- image (Image) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageCreateSummary
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageCreateSummary.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - is_batch_successful (bool) –
- images (list[ImageCreateResult]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
Region
(*, tag_id: str = None, left: float = None, top: float = None, width: float = None, height: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Region.
Parameters: - tag_id (str) –
- left (float) –
- top (float) –
- width (float) –
- height (float) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageFileCreateEntry
(*, name: str = None, contents: bytearray = None, tag_ids=None, regions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageFileCreateEntry.
Parameters: - name (str) –
- contents (bytearray) –
- tag_ids (list[str]) –
- regions (list[Region]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageFileCreateBatch
(*, images=None, tag_ids=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageFileCreateBatch.
Parameters: - images (list[ImageFileCreateEntry]) –
- tag_ids (list[str]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageUrlCreateEntry
(*, url: str = None, tag_ids=None, regions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageUrlCreateEntry.
Parameters: - url (str) –
- tag_ids (list[str]) –
- regions (list[Region]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageUrlCreateBatch
(*, images=None, tag_ids=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageUrlCreateBatch.
Parameters: - images (list[ImageUrlCreateEntry]) –
- tag_ids (list[str]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageIdCreateEntry
(*, id: str = None, tag_ids=None, regions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageIdCreateEntry.
Parameters: - id (str) –
- tag_ids (list[str]) –
- regions (list[Region]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageIdCreateBatch
(*, images=None, tag_ids=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageIdCreateBatch.
Parameters: - images (list[ImageIdCreateEntry]) –
- tag_ids (list[str]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageTagCreateEntry
(*, image_id: str = None, tag_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageTagCreateEntry.
Parameters: - image_id (str) –
- tag_id (str) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageTagCreateBatch
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageTagCreateBatch.
Parameters: tags (list[ImageTagCreateEntry]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageTagCreateSummary
(*, created=None, duplicated=None, exceeded=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageTagCreateSummary.
Parameters: - created (list[ImageTagCreateEntry]) –
- duplicated (list[ImageTagCreateEntry]) –
- exceeded (list[ImageTagCreateEntry]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageRegionCreateEntry
(*, image_id: str = None, tag_id: str = None, left: float = None, top: float = None, width: float = None, height: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageRegionCreateEntry.
Parameters: - image_id (str) –
- tag_id (str) –
- left (float) –
- top (float) –
- width (float) –
- height (float) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageRegionCreateBatch
(*, regions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Batch of image region information to create.
Parameters: regions (list[ImageRegionCreateEntry]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageRegionCreateResult
(*, tag_id: str = None, left: float = None, top: float = None, width: float = None, height: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageRegionCreateResult.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - image_id (str) –
- region_id (str) –
- tag_name (str) –
- created (datetime) –
Parameters: - tag_id (str) –
- left (float) –
- top (float) –
- width (float) –
- height (float) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageRegionCreateSummary
(*, created=None, duplicated=None, exceeded=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageRegionCreateSummary.
Parameters: - created (list[ImageRegionCreateResult]) –
- duplicated (list[ImageRegionCreateEntry]) –
- exceeded (list[ImageRegionCreateEntry]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
BoundingBox
(*, left: float = None, top: float = None, width: float = None, height: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
BoundingBox.
Parameters: - left (float) –
- top (float) –
- width (float) –
- height (float) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
RegionProposal
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
RegionProposal.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - confidence (float) –
- bounding_box (BoundingBox) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageRegionProposal
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageRegionProposal.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - project_id (str) –
- image_id (str) –
- proposals (list[RegionProposal]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
PredictionQueryTag
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
PredictionQueryTag.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) –
- min_threshold (float) –
- max_threshold (float) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
PredictionQueryToken
(*, session: str = None, continuation: str = None, max_count: int = None, order_by=None, tags=None, iteration_id: str = None, start_time=None, end_time=None, application: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
PredictionQueryToken.
Parameters: - session (str) –
- continuation (str) –
- max_count (int) –
- order_by (str or OrderBy) – Possible values include: ‘Newest’, ‘Oldest’, ‘Suggested’
- tags (list[PredictionQueryTag]) –
- iteration_id (str) –
- start_time (datetime) –
- end_time (datetime) –
- application (str) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
Prediction
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Prediction.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - probability (float) –
- tag_id (str) –
- tag_name (str) –
- bounding_box (BoundingBox) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
StoredImagePrediction
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
result of an image classification request.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - image_uri (str) –
- thumbnail_uri (str) –
- domain (str) –
- id (str) –
- project (str) –
- iteration (str) –
- created (datetime) –
- predictions (list[Prediction]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
PredictionQueryResult
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
PredictionQueryResult.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - token (PredictionQueryToken) –
- results (list[StoredImagePrediction]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageUrl
(*, url: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ImageUrl.
Parameters: url (str) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImagePrediction
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ImagePrediction.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) –
- project (str) –
- iteration (str) –
- created (datetime) –
- predictions (list[Prediction]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
Iteration
(*, name: str = None, is_default: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Iteration model to be sent over JSON.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - 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
- 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’
Parameters: - name (str) – Gets or sets the name of the iteration
- is_default (bool) – Gets or sets a value indicating whether the iteration is the default iteration for the project
-
class
azure.cognitiveservices.vision.customvision.training.models.
ProjectSettings
(*, domain_id: str = None, classification_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents settings associated with a project.
Parameters: - domain_id (str) – Gets or sets the id of the Domain to use with this project
- classification_type (str or Classifier) – Gets or sets the classification type of the project. Possible values include: ‘Multiclass’, ‘Multilabel’
-
class
azure.cognitiveservices.vision.customvision.training.models.
Project
(*, name: str = None, description: str = None, settings=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents a project.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Gets the project id
- created (datetime) – Gets the date this project was created
- last_modified (datetime) – Gets the date this project was last modifed
- thumbnail_uri (str) – Gets the thumbnail url representing the project
Parameters: - name (str) – Gets or sets the name of the project
- description (str) – Gets or sets the description of the project
- settings (ProjectSettings) – Gets or sets the project settings
-
class
azure.cognitiveservices.vision.customvision.training.models.
TagPerformance
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents performance data for a particular tag in a trained iteration.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) –
- name (str) –
- precision (float) – Gets the precision
- precision_std_deviation (float) – Gets the standard deviation for the precision
- recall (float) – Gets the recall
- recall_std_deviation (float) – Gets the standard deviation for the recall
- average_precision (float) – Gets the average precision when applicable
-
class
azure.cognitiveservices.vision.customvision.training.models.
IterationPerformance
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the detailed performance data for a trained iteration.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - per_tag_performance (list[TagPerformance]) – Gets the per-tag performance details for this iteration
- precision (float) – Gets the precision
- precision_std_deviation (float) – Gets the standard deviation for the precision
- recall (float) – Gets the recall
- recall_std_deviation (float) – Gets the standard deviation for the recall
- average_precision (float) – Gets the average precision when applicable
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImagePerformance
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Image performance model.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - predictions (list[Prediction]) –
- id (str) –
- created (datetime) –
- width (int) –
- height (int) –
- image_uri (str) –
- thumbnail_uri (str) –
- tags (list[ImageTag]) –
- regions (list[ImageRegion]) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
Export
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Export.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - platform (str or ExportPlatform) – Possible values include: ‘CoreML’, ‘TensorFlow’, ‘DockerFile’, ‘ONNX’
- status (str or ExportStatusModel) – Possible values include: ‘Exporting’, ‘Failed’, ‘Done’
- download_uri (str) –
- flavor (str or ExportFlavor) – Possible values include: ‘Linux’, ‘Windows’
- newer_version_available (bool) –
-
class
azure.cognitiveservices.vision.customvision.training.models.
Tag
(*, name: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents a Tag.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Gets the Tag ID
- image_count (int) – Gets the number of images with this tag
Parameters: - name (str) – Gets or sets the name of the tag
- description (str) – Gets or sets the description of the tag
-
class
azure.cognitiveservices.vision.customvision.training.models.
DomainType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
classification
= 'Classification'¶
-
object_detection
= 'ObjectDetection'¶
-
-
class
azure.cognitiveservices.vision.customvision.training.models.
ImageUploadStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
error_image_format
= 'ErrorImageFormat'¶
-
error_image_size
= 'ErrorImageSize'¶
-
error_limit_exceed
= 'ErrorLimitExceed'¶
-
error_region_limit_exceed
= 'ErrorRegionLimitExceed'¶
-
error_source
= 'ErrorSource'¶
-
error_storage
= 'ErrorStorage'¶
-
error_tag_limit_exceed
= 'ErrorTagLimitExceed'¶
-
error_unknown
= 'ErrorUnknown'¶
-
ok
= 'OK'¶
-
ok_duplicate
= 'OKDuplicate'¶
-
-
class
azure.cognitiveservices.vision.customvision.training.models.
OrderBy
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
newest
= 'Newest'¶
-
oldest
= 'Oldest'¶
-
suggested
= 'Suggested'¶
-
-
class
azure.cognitiveservices.vision.customvision.training.models.
Classifier
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
multiclass
= 'Multiclass'¶
-
multilabel
= 'Multilabel'¶
-
-
class
azure.cognitiveservices.vision.customvision.training.models.
ExportPlatform
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
core_ml
= 'CoreML'¶
-
docker_file
= 'DockerFile'¶
-
onnx
= 'ONNX'¶
-
tensor_flow
= 'TensorFlow'¶
-