Microsoft.MachineLearningServices workspaces/labelingJobs 2020-09-01-preview

• Latest
• 2024-04-01-preview
• 2024-01-01-preview
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01-preview
• 2022-06-01-preview
• 2021-03-01-preview
• 2020-09-01-preview

Bicep resource definition

The workspaces/labelingJobs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/labelingJobs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/labelingJobs@2020-09-01-preview' = {
  name: 'string'
  properties: {
    datasetConfiguration: {
      assetName: 'string'
      datasetVersion: 'string'
      enableIncrementalDatasetRefresh: bool
    }
    jobInstructions: {
      uri: 'string'
    }
    labelCategories: {
      {customized property}: {
        allowMultiSelect: bool
        classes: {
          {customized property}: {
            displayName: 'string'
            subclasses: {
              {customized property}: ...
            }
          }
        }
        displayName: 'string'
      }
    }
    labelingJobMediaProperties: {
      annotationType: 'string'
      mediaType: 'string'
    }
    mlAssistConfiguration: {
      inferencingComputeBinding: {
        computeId: 'string'
        nodeCount: int
      }
      mlAssistEnabled: bool
      modelNamePrefix: 'string'
      prelabelAccuracyThreshold: int
      trainingComputeBinding: {
        computeId: 'string'
        nodeCount: int
      }
    }
    properties: {
      {customized property}: 'string'
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

Property values

ComputeBinding

Name	Description	Value
computeId	ID of the compute resource.	string
nodeCount	Number of nodes.	int

LabelCategory

Name	Description	Value
allowMultiSelect	Indicates whether it is allowed to select multiple classes in this category.	bool
classes	Dictionary of label classes in this category.	LabelCategoryClasses (required)
displayName	Display name of the label category.	string

LabelCategoryClasses

Name	Description	Value

LabelClass

Name	Description	Value
displayName	Display name of the label class.	string
subclasses	Dictionary of subclasses of the label class.	LabelClassSubclasses

LabelClassSubclasses

Name	Description	Value

LabelingDatasetConfiguration

Name	Description	Value
assetName	Name of the data asset to perform labeling.	string (required)
datasetVersion	AML dataset version.	string (required)
enableIncrementalDatasetRefresh	Indicates whether to enable incremental dataset refresh.	bool

LabelingJobImageProperties

Name	Description	Value
annotationType	Annotation type of image labeling tasks.	'BoundingBox' 'Classification' 'InstanceSegmentation'
mediaType	Media type of data asset.	'Image' 'Text' (required)

LabelingJobInstructions

Name	Description	Value
uri	The link to a page with detailed labeling instructions for labelers.	string

LabelingJobProperties

Name	Description	Value
datasetConfiguration	Dataset configuration for the job.	LabelingDatasetConfiguration (required)
jobInstructions	Instructions for the job.	LabelingJobInstructions (required)
labelCategories	Label categories of the job.	LabelingJobPropertiesLabelCategories (required)
labelingJobMediaProperties	Media specific properties in a labeling job.	LabelingJobImageProperties (required)
mlAssistConfiguration	Machine learning assisted configuration for the job.	MLAssistConfiguration
properties	The job property dictionary. Properties can be added, but not removed or altered.	LabelingJobProperties
tags	The job tag dictionary. Tags can be added, removed, and updated.	LabelingJobPropertiesTags

LabelingJobProperties

Name	Description	Value

LabelingJobPropertiesLabelCategories

Name	Description	Value

LabelingJobPropertiesTags

Name	Description	Value

Microsoft.MachineLearningServices/workspaces/labelingJobs

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: workspaces
properties	Definition of a labeling job.	LabelingJobProperties

MLAssistConfiguration

Name	Description	Value
inferencingComputeBinding	The compute designated for inferencing.	ComputeBinding (required)
mlAssistEnabled	Indicates whether MLAssist feature is enabled.	bool
modelNamePrefix	Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.	string (required)
prelabelAccuracyThreshold	Prelabel accuracy threshold used in MLAssist feature.	int
trainingComputeBinding	The compute designated for training.	ComputeBinding (required)

ARM template resource definition

The workspaces/labelingJobs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/labelingJobs resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs",
  "apiVersion": "2020-09-01-preview",
  "name": "string",
  "properties": {
    "datasetConfiguration": {
      "assetName": "string",
      "datasetVersion": "string",
      "enableIncrementalDatasetRefresh": "bool"
    },
    "jobInstructions": {
      "uri": "string"
    },
    "labelCategories": {
      "{customized property}": {
        "allowMultiSelect": "bool",
        "classes": {
          "{customized property}": {
            "displayName": "string",
            "subclasses": {
              "{customized property}": ...
            }
          }
        },
        "displayName": "string"
      }
    },
    "labelingJobMediaProperties": {
      "annotationType": "string",
      "mediaType": "string"
    },
    "mlAssistConfiguration": {
      "inferencingComputeBinding": {
        "computeId": "string",
        "nodeCount": "int"
      },
      "mlAssistEnabled": "bool",
      "modelNamePrefix": "string",
      "prelabelAccuracyThreshold": "int",
      "trainingComputeBinding": {
        "computeId": "string",
        "nodeCount": "int"
      }
    },
    "properties": {
      "{customized property}": "string"
    },
    "tags": {
      "{customized property}": "string"
    }
  }
}

Property values

ComputeBinding

Name	Description	Value
computeId	ID of the compute resource.	string
nodeCount	Number of nodes.	int

LabelCategory

Name	Description	Value
allowMultiSelect	Indicates whether it is allowed to select multiple classes in this category.	bool
classes	Dictionary of label classes in this category.	LabelCategoryClasses (required)
displayName	Display name of the label category.	string

LabelCategoryClasses

Name	Description	Value

LabelClass

Name	Description	Value
displayName	Display name of the label class.	string
subclasses	Dictionary of subclasses of the label class.	LabelClassSubclasses

LabelClassSubclasses

Name	Description	Value

LabelingDatasetConfiguration

Name	Description	Value
assetName	Name of the data asset to perform labeling.	string (required)
datasetVersion	AML dataset version.	string (required)
enableIncrementalDatasetRefresh	Indicates whether to enable incremental dataset refresh.	bool

LabelingJobImageProperties

Name	Description	Value
annotationType	Annotation type of image labeling tasks.	'BoundingBox' 'Classification' 'InstanceSegmentation'
mediaType	Media type of data asset.	'Image' 'Text' (required)

LabelingJobInstructions

Name	Description	Value
uri	The link to a page with detailed labeling instructions for labelers.	string

LabelingJobProperties

Name	Description	Value
datasetConfiguration	Dataset configuration for the job.	LabelingDatasetConfiguration (required)
jobInstructions	Instructions for the job.	LabelingJobInstructions (required)
labelCategories	Label categories of the job.	LabelingJobPropertiesLabelCategories (required)
labelingJobMediaProperties	Media specific properties in a labeling job.	LabelingJobImageProperties (required)
mlAssistConfiguration	Machine learning assisted configuration for the job.	MLAssistConfiguration
properties	The job property dictionary. Properties can be added, but not removed or altered.	LabelingJobProperties
tags	The job tag dictionary. Tags can be added, removed, and updated.	LabelingJobPropertiesTags

LabelingJobProperties

Name	Description	Value

LabelingJobPropertiesLabelCategories

Name	Description	Value

LabelingJobPropertiesTags

Name	Description	Value

Microsoft.MachineLearningServices/workspaces/labelingJobs

Name	Description	Value
apiVersion	The api version	'2020-09-01-preview'
name	The resource name	string (required)
properties	Definition of a labeling job.	LabelingJobProperties
type	The resource type	'Microsoft.MachineLearningServices/workspaces/labelingJobs'

MLAssistConfiguration

Name	Description	Value
inferencingComputeBinding	The compute designated for inferencing.	ComputeBinding (required)
mlAssistEnabled	Indicates whether MLAssist feature is enabled.	bool
modelNamePrefix	Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.	string (required)
prelabelAccuracyThreshold	Prelabel accuracy threshold used in MLAssist feature.	int
trainingComputeBinding	The compute designated for training.	ComputeBinding (required)

Terraform (AzAPI provider) resource definition

The workspaces/labelingJobs resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/labelingJobs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/labelingJobs@2020-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      datasetConfiguration = {
        assetName = "string"
        datasetVersion = "string"
        enableIncrementalDatasetRefresh = bool
      }
      jobInstructions = {
        uri = "string"
      }
      labelCategories = {
        {customized property} = {
          allowMultiSelect = bool
          classes = {
            {customized property} = {
              displayName = "string"
              subclasses = {
                {customized property} = ...
              }
            }
          }
          displayName = "string"
        }
      }
      labelingJobMediaProperties = {
        annotationType = "string"
        mediaType = "string"
      }
      mlAssistConfiguration = {
        inferencingComputeBinding = {
          computeId = "string"
          nodeCount = int
        }
        mlAssistEnabled = bool
        modelNamePrefix = "string"
        prelabelAccuracyThreshold = int
        trainingComputeBinding = {
          computeId = "string"
          nodeCount = int
        }
      }
      properties = {
        {customized property} = "string"
      }
      tags = {
        {customized property} = "string"
      }
    }
  })
}

Property values

ComputeBinding

Name	Description	Value
computeId	ID of the compute resource.	string
nodeCount	Number of nodes.	int

LabelCategory

Name	Description	Value
allowMultiSelect	Indicates whether it is allowed to select multiple classes in this category.	bool
classes	Dictionary of label classes in this category.	LabelCategoryClasses (required)
displayName	Display name of the label category.	string

LabelCategoryClasses

Name	Description	Value

LabelClass

Name	Description	Value
displayName	Display name of the label class.	string
subclasses	Dictionary of subclasses of the label class.	LabelClassSubclasses

LabelClassSubclasses

Name	Description	Value

LabelingDatasetConfiguration

Name	Description	Value
assetName	Name of the data asset to perform labeling.	string (required)
datasetVersion	AML dataset version.	string (required)
enableIncrementalDatasetRefresh	Indicates whether to enable incremental dataset refresh.	bool

LabelingJobImageProperties

Name	Description	Value
annotationType	Annotation type of image labeling tasks.	'BoundingBox' 'Classification' 'InstanceSegmentation'
mediaType	Media type of data asset.	'Image' 'Text' (required)

LabelingJobInstructions

Name	Description	Value
uri	The link to a page with detailed labeling instructions for labelers.	string

LabelingJobProperties

Name	Description	Value
datasetConfiguration	Dataset configuration for the job.	LabelingDatasetConfiguration (required)
jobInstructions	Instructions for the job.	LabelingJobInstructions (required)
labelCategories	Label categories of the job.	LabelingJobPropertiesLabelCategories (required)
labelingJobMediaProperties	Media specific properties in a labeling job.	LabelingJobImageProperties (required)
mlAssistConfiguration	Machine learning assisted configuration for the job.	MLAssistConfiguration
properties	The job property dictionary. Properties can be added, but not removed or altered.	LabelingJobProperties
tags	The job tag dictionary. Tags can be added, removed, and updated.	LabelingJobPropertiesTags

LabelingJobProperties

Name	Description	Value

LabelingJobPropertiesLabelCategories

Name	Description	Value

LabelingJobPropertiesTags

Name	Description	Value

Microsoft.MachineLearningServices/workspaces/labelingJobs

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: workspaces
properties	Definition of a labeling job.	LabelingJobProperties
type	The resource type	"Microsoft.MachineLearningServices/workspaces/labelingJobs@2020-09-01-preview"

MLAssistConfiguration

Name	Description	Value
inferencingComputeBinding	The compute designated for inferencing.	ComputeBinding (required)
mlAssistEnabled	Indicates whether MLAssist feature is enabled.	bool
modelNamePrefix	Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.	string (required)
prelabelAccuracyThreshold	Prelabel accuracy threshold used in MLAssist feature.	int
trainingComputeBinding	The compute designated for training.	ComputeBinding (required)