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, and provides detailed information about a MLModel.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.MachineLearning.Model.GetMLModelResponse

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

Syntax

C#
public class GetMLModelResponse : AmazonWebServiceResponse

The GetMLModelResponse type exposes the following members

Constructors

NameDescription
Public Method GetMLModelResponse()

Properties

NameTypeDescription
Public Property ComputeTime System.Int64

Gets and sets the property ComputeTime.

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
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.

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
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 LogUri System.String

Gets and sets the property LogUri.

A link to the file that contains logs of the CreateMLModel operation.

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 MLModel ID, which is same as the MLModelId in the request.

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 an e-commerce website?"
  • 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 Recipe System.String

Gets and sets the property Recipe.

The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.

Note

This parameter is provided as part of the verbose format.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Schema System.String

Gets and sets the property Schema.

The schema used by all of the data files referenced by the DataSource.

Note

This parameter is provided as part of the verbose format.

Public Property ScoreThreshold System.Single

Gets and sets the property ScoreThreshold.

The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.

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.

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

Public Property Status Amazon.MachineLearning.EntityStatus

Gets and sets the property Status.

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

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.
  • INPROGRESS - The request is processing.
  • FAILED - The request did not run to completion. The ML model isn't usable.
  • COMPLETED - The request 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.

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 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. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a 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. It 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