AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents the output of a GetMLModel operation.

The content consists of the detailed metadata and the current status of the MLModel.

Inheritance Hierarchy

System.Object
  Amazon.MachineLearning.Model.MLModel

Namespace: Amazon.MachineLearning.Model
Assembly: AWSSDK.MachineLearning.dll
Version: 3.x.y.z

Syntax

C#
public class MLModel

The MLModel type exposes the following members

Constructors

NameDescription
Public Method MLModel()

Properties

NameTypeDescription
Public Property Algorithm Amazon.MachineLearning.Algorithm

Gets and sets the property Algorithm.

The algorithm used to train the MLModel. The following algorithm is supported:

  • SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function.

Public Property ComputeTime System.Int64

Gets and sets the property ComputeTime.

Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

The time that the MLModel was created. The time is expressed in epoch time.

Public Property CreatedByIamUser System.String

Gets and sets the property CreatedByIamUser.

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

Public Property EndpointInfo Amazon.MachineLearning.Model.RealtimeEndpointInfo

Gets and sets the property EndpointInfo.

The current endpoint of the MLModel.

Public Property FinishedAt System.DateTime

Gets and sets the property FinishedAt.

Public Property InputDataLocationS3 System.String

Gets and sets the property InputDataLocationS3.

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

Public Property LastUpdatedAt System.DateTime

Gets and sets the property LastUpdatedAt.

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

Public Property Message System.String

Gets and sets the property Message.

A description of the most recent details about accessing the MLModel.

Public Property MLModelId System.String

Gets and sets the property MLModelId.

The ID assigned to the MLModel at creation.

Public Property MLModelType Amazon.MachineLearning.MLModelType

Gets and sets the property MLModelType.

Identifies the MLModel category. The following are the available types:

  • REGRESSION - Produces a numeric result. For example, "What price should a house be listed at?"
  • BINARY - Produces one of two possible results. For example, "Is this a child-friendly web site?".
  • MULTICLASS - Produces one of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk trade?".

Public Property Name System.String

Gets and sets the property Name.

A user-supplied name or description of the MLModel.

Public Property ScoreThreshold System.Single

Gets and sets the property ScoreThreshold.

Public Property ScoreThresholdLastUpdatedAt System.DateTime

Gets and sets the property ScoreThresholdLastUpdatedAt.

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

Public Property SizeInBytes System.Int64

Gets and sets the property SizeInBytes.

Public Property StartedAt System.DateTime

Gets and sets the property StartedAt.

Public Property Status Amazon.MachineLearning.EntityStatus

Gets and sets the property Status.

The current status of an MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create an MLModel didn't run to completion. The model isn't usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The MLModel is marked as deleted. It isn't usable.

Public Property TrainingDataSourceId System.String

Gets and sets the property TrainingDataSourceId.

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

Public Property TrainingParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property TrainingParameters.

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms