AutoMlJob Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
AutoMLJob class. Use this class for executing AutoML tasks like Classification/Regression etc. See TaskType enum for all the tasks supported.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AutoMlJobTypeConverter))]
public class AutoMlJob : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IAutoMlJob, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AutoMlJobTypeConverter))>]
type AutoMlJob = class
interface IAutoMlJob
interface IJsonSerializable
interface IJobBaseProperties
interface IResourceBase
interface IValidates
Public Class AutoMlJob
Implements IAutoMlJob, IValidates
- Inheritance
-
AutoMlJob
- Attributes
- Implements
Constructors
AutoMlJob() |
Creates an new AutoMlJob instance. |
Properties
ComponentId |
ARM resource ID of the component resource. |
ComputeId |
ARM resource ID of the compute resource. |
Description |
The asset description text. |
DisplayName |
Display name of job. |
EnvironmentId |
The ARM resource ID of the Environment specification for the job. This is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job. |
EnvironmentVariable |
Environment variables included in the job. |
ExperimentName |
The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. |
Identity |
Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. |
IdentityType |
[Required] Specifies the type of identity framework. |
IsArchived |
Is the asset archived? |
JobType |
[Required] Specifies the type of job. |
NotificationSetting |
Notification setting for the job |
NotificationSettingEmail |
This is the email recipient list which has a limitation of 499 characters in total concat with comma separator |
NotificationSettingEmailOn |
Send email notification to user on specified notification type |
NotificationSettingWebhook |
Send webhook callback to a service. Key is a user-provided name for the webhook. |
Output |
Mapping of output data bindings used in the job. |
Property |
The asset property dictionary. |
QueueSettingJobTier |
Controls the compute job tier |
ResourceDockerArg |
Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types. |
ResourceInstanceCount |
Optional number of instances or nodes used by the compute target. |
ResourceInstanceType |
Optional type of VM used as supported by the compute target. |
ResourceProperty |
Additional properties bag. |
ResourceShmSize |
Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes). |
Service |
List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. |
Status |
Status of the job. |
Tag |
Tag dictionary. Tags can be added, removed, and updated. |
TaskDetailLogVerbosity |
Log verbosity for the job. |
TaskDetailTargetColumnName |
Target column name: This is prediction values column. Also known as label column name in context of classification tasks. |
TaskDetailTaskType |
[Required] Task type for AutoMLJob. |
TrainingDataDescription |
Description for the input. |
TrainingDataJobInputType |
[Required] Specifies the type of job. |
TrainingDataMode |
Input Asset Delivery Mode. |
TrainingDataUri |
[Required] Input Asset URI. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of AutoMlJob. |
DeserializeFromPSObject(PSObject) | |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IAutoMlJob. |
FromJsonString(String) |
Creates a new instance of AutoMlJob, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) | |
ToJsonString() |
Serializes this instance to a json string. |
ToString() | |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |