ArmMachineLearningModelFactory.MachineLearningBatchDeploymentProperties Method
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.
Overloads
MachineLearningBatchDeploymentProperties(String, IDictionary<String, String>, MachineLearningCodeConfiguration, String, IDictionary<String, String>, String, BatchDeploymentConfiguration, Nullable<Int32>, MachineLearningBatchRetrySettings, Nullable<Int64>, Nullable<MachineLearningBatchLoggingLevel>, MachineLearningAssetReferenceBase, Nullable<Int32>, Nullable<MachineLearningBatchOutputAction>, String, MachineLearningDeploymentResourceConfiguration, Nullable<MachineLearningDeploymentProvisioningState>)
Initializes a new instance of MachineLearningBatchDeploymentProperties.
public static Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchDeploymentProperties MachineLearningBatchDeploymentProperties (string description = default, System.Collections.Generic.IDictionary<string,string> properties = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningCodeConfiguration codeConfiguration = default, string environmentId = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, string compute = default, Azure.ResourceManager.MachineLearning.Models.BatchDeploymentConfiguration deploymentConfiguration = default, int? errorThreshold = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchRetrySettings retrySettings = default, long? miniBatchSize = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchLoggingLevel? loggingLevel = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningAssetReferenceBase model = default, int? maxConcurrencyPerInstance = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchOutputAction? outputAction = default, string outputFileName = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentResourceConfiguration resources = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentProvisioningState? provisioningState = default);
static member MachineLearningBatchDeploymentProperties : string * System.Collections.Generic.IDictionary<string, string> * Azure.ResourceManager.MachineLearning.Models.MachineLearningCodeConfiguration * string * System.Collections.Generic.IDictionary<string, string> * string * Azure.ResourceManager.MachineLearning.Models.BatchDeploymentConfiguration * Nullable<int> * Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchRetrySettings * Nullable<int64> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchLoggingLevel> * Azure.ResourceManager.MachineLearning.Models.MachineLearningAssetReferenceBase * Nullable<int> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchOutputAction> * string * Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentResourceConfiguration * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentProvisioningState> -> Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchDeploymentProperties
Public Shared Function MachineLearningBatchDeploymentProperties (Optional description As String = Nothing, Optional properties As IDictionary(Of String, String) = Nothing, Optional codeConfiguration As MachineLearningCodeConfiguration = Nothing, Optional environmentId As String = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional compute As String = Nothing, Optional deploymentConfiguration As BatchDeploymentConfiguration = Nothing, Optional errorThreshold As Nullable(Of Integer) = Nothing, Optional retrySettings As MachineLearningBatchRetrySettings = Nothing, Optional miniBatchSize As Nullable(Of Long) = Nothing, Optional loggingLevel As Nullable(Of MachineLearningBatchLoggingLevel) = Nothing, Optional model As MachineLearningAssetReferenceBase = Nothing, Optional maxConcurrencyPerInstance As Nullable(Of Integer) = Nothing, Optional outputAction As Nullable(Of MachineLearningBatchOutputAction) = Nothing, Optional outputFileName As String = Nothing, Optional resources As MachineLearningDeploymentResourceConfiguration = Nothing, Optional provisioningState As Nullable(Of MachineLearningDeploymentProvisioningState) = Nothing) As MachineLearningBatchDeploymentProperties
Parameters
- description
- String
Description of the endpoint deployment.
- properties
- IDictionary<String,String>
Property dictionary. Properties can be added, but not removed or altered.
- codeConfiguration
- MachineLearningCodeConfiguration
Code configuration for the endpoint deployment.
- environmentId
- String
ARM resource ID or AssetId of the environment specification for the endpoint deployment.
- environmentVariables
- IDictionary<String,String>
Environment variables configuration for the deployment.
- compute
- String
Compute target for batch inference operation.
- deploymentConfiguration
- BatchDeploymentConfiguration
Properties relevant to different deployment types. Please note BatchDeploymentConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BatchPipelineComponentDeploymentConfiguration.
Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored.
- retrySettings
- MachineLearningBatchRetrySettings
Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.
Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch.
- loggingLevel
- Nullable<MachineLearningBatchLoggingLevel>
Logging level for batch inference operation.
Reference to the model asset for the endpoint deployment. Please note MachineLearningAssetReferenceBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MachineLearningDataPathAssetReference, MachineLearningIdAssetReference and MachineLearningOutputPathAssetReference.
- outputAction
- Nullable<MachineLearningBatchOutputAction>
Indicates how the output will be organized.
- outputFileName
- String
Customized output file name for append_row output action.
Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
- provisioningState
- Nullable<MachineLearningDeploymentProvisioningState>
Provisioning state for the endpoint deployment.
Returns
A new MachineLearningBatchDeploymentProperties instance for mocking.
Applies to
MachineLearningBatchDeploymentProperties(MachineLearningCodeConfiguration, String, String, IDictionary<String,String>, IDictionary<String, String>, String, BatchDeploymentConfiguration, Nullable<Int32>, Nullable<MachineLearningBatchLoggingLevel>, Nullable<Int32>, Nullable<Int64>, MachineLearningAssetReferenceBase, Nullable<MachineLearningBatchOutputAction>, String, Nullable<MachineLearningDeploymentProvisioningState>, MachineLearningDeploymentResourceConfiguration, MachineLearningBatchRetrySettings)
Initializes a new instance of MachineLearningBatchDeploymentProperties.
public static Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchDeploymentProperties MachineLearningBatchDeploymentProperties (Azure.ResourceManager.MachineLearning.Models.MachineLearningCodeConfiguration codeConfiguration = default, string description = default, string environmentId = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, System.Collections.Generic.IDictionary<string,string> properties = default, string compute = default, Azure.ResourceManager.MachineLearning.Models.BatchDeploymentConfiguration deploymentConfiguration = default, int? errorThreshold = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchLoggingLevel? loggingLevel = default, int? maxConcurrencyPerInstance = default, long? miniBatchSize = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningAssetReferenceBase model = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchOutputAction? outputAction = default, string outputFileName = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentProvisioningState? provisioningState = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentResourceConfiguration resources = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchRetrySettings retrySettings = default);
static member MachineLearningBatchDeploymentProperties : Azure.ResourceManager.MachineLearning.Models.MachineLearningCodeConfiguration * string * string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * string * Azure.ResourceManager.MachineLearning.Models.BatchDeploymentConfiguration * Nullable<int> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchLoggingLevel> * Nullable<int> * Nullable<int64> * Azure.ResourceManager.MachineLearning.Models.MachineLearningAssetReferenceBase * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchOutputAction> * string * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentProvisioningState> * Azure.ResourceManager.MachineLearning.Models.MachineLearningDeploymentResourceConfiguration * Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchRetrySettings -> Azure.ResourceManager.MachineLearning.Models.MachineLearningBatchDeploymentProperties
Public Shared Function MachineLearningBatchDeploymentProperties (Optional codeConfiguration As MachineLearningCodeConfiguration = Nothing, Optional description As String = Nothing, Optional environmentId As String = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional properties As IDictionary(Of String, String) = Nothing, Optional compute As String = Nothing, Optional deploymentConfiguration As BatchDeploymentConfiguration = Nothing, Optional errorThreshold As Nullable(Of Integer) = Nothing, Optional loggingLevel As Nullable(Of MachineLearningBatchLoggingLevel) = Nothing, Optional maxConcurrencyPerInstance As Nullable(Of Integer) = Nothing, Optional miniBatchSize As Nullable(Of Long) = Nothing, Optional model As MachineLearningAssetReferenceBase = Nothing, Optional outputAction As Nullable(Of MachineLearningBatchOutputAction) = Nothing, Optional outputFileName As String = Nothing, Optional provisioningState As Nullable(Of MachineLearningDeploymentProvisioningState) = Nothing, Optional resources As MachineLearningDeploymentResourceConfiguration = Nothing, Optional retrySettings As MachineLearningBatchRetrySettings = Nothing) As MachineLearningBatchDeploymentProperties
Parameters
- codeConfiguration
- MachineLearningCodeConfiguration
Code configuration for the endpoint deployment.
- description
- String
Description of the endpoint deployment.
- environmentId
- String
ARM resource ID of the environment specification for the endpoint deployment.
- environmentVariables
- IDictionary<String,String>
Environment variables configuration for the deployment.
- properties
- IDictionary<String,String>
Property dictionary. Properties can be added, but not removed or altered.
- compute
- String
Compute target for batch inference operation.
- deploymentConfiguration
- BatchDeploymentConfiguration
Properties relevant to different deployment types. Please note BatchDeploymentConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BatchPipelineComponentDeploymentConfiguration.
Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored.
- loggingLevel
- Nullable<MachineLearningBatchLoggingLevel>
Logging level for batch inference operation.
Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch.
Reference to the model asset for the endpoint deployment. Please note MachineLearningAssetReferenceBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MachineLearningDataPathAssetReference, MachineLearningOutputPathAssetReference and MachineLearningIdAssetReference.
- outputAction
- Nullable<MachineLearningBatchOutputAction>
Indicates how the output will be organized.
- outputFileName
- String
Customized output file name for append_row output action.
- provisioningState
- Nullable<MachineLearningDeploymentProvisioningState>
Provisioning state for the endpoint deployment.
Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
- retrySettings
- MachineLearningBatchRetrySettings
Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.
Returns
A new MachineLearningBatchDeploymentProperties instance for mocking.
Applies to
Azure SDK for .NET