AWSMachineLearningGetMLModelOutput Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSMachineLearningModel.h
AWSMachineLearningModel.m

Overview

Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.

  createdAt

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

@property (nonatomic, strong) NSDate *createdAt

Declared In

AWSMachineLearningModel.h

  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.

@property (nonatomic, strong) NSString *createdByIamUser

Declared In

AWSMachineLearningModel.h

  endpointInfo

The current endpoint of the MLModel

@property (nonatomic, strong) AWSMachineLearningRealtimeEndpointInfo *endpointInfo

Declared In

AWSMachineLearningModel.h

  inputDataLocationS3

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

@property (nonatomic, strong) NSString *inputDataLocationS3

Declared In

AWSMachineLearningModel.h

  lastUpdatedAt

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

@property (nonatomic, strong) NSDate *lastUpdatedAt

Declared In

AWSMachineLearningModel.h

  logUri

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

@property (nonatomic, strong) NSString *logUri

Declared In

AWSMachineLearningModel.h

  MLModelId

The MLModel ID which is same as the MLModelId in the request.

@property (nonatomic, strong) NSString *MLModelId

Declared In

AWSMachineLearningModel.h

  MLModelType

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

  • REGRESSION -- Produces a numeric result. For example, "What listing price should a house have?"
  • BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"
  • MULTICLASS -- Produces more than two possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"
@property (nonatomic, assign) AWSMachineLearningMLModelType MLModelType

Declared In

AWSMachineLearningModel.h

  message

Description of the most recent details about accessing the MLModel.

@property (nonatomic, strong) NSString *message

Declared In

AWSMachineLearningModel.h

  name

A user-supplied name or description of the MLModel.

@property (nonatomic, strong) NSString *name

Declared In

AWSMachineLearningModel.h

  recipe

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

Note

This parameter is provided as part of the verbose format.

@property (nonatomic, strong) NSString *recipe

Declared In

AWSMachineLearningModel.h

  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.

@property (nonatomic, strong) NSString *schema

Declared In

AWSMachineLearningModel.h

  scoreThreshold

The scoring threshold is used in binary classification MLModels, and 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.

@property (nonatomic, strong) NSNumber *scoreThreshold

Declared In

AWSMachineLearningModel.h

  scoreThresholdLastUpdatedAt

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

@property (nonatomic, strong) NSDate *scoreThresholdLastUpdatedAt

Declared In

AWSMachineLearningModel.h

  sizeInBytes

Long integer type that is a 64-bit signed number.

@property (nonatomic, strong) NSNumber *sizeInBytes

Declared In

AWSMachineLearningModel.h

  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. It is not usable.
  • COMPLETED - The request completed successfully.
  • DELETED - The MLModel is marked as deleted. It is not usable.
@property (nonatomic, assign) AWSMachineLearningEntityStatus status

Declared In

AWSMachineLearningModel.h

  trainingDataSourceId

The ID of the training DataSource.

@property (nonatomic, strong) NSString *trainingDataSourceId

Declared In

AWSMachineLearningModel.h

  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.l1RegularizationAmount - 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, specify a small value, such as 1.0E-04 or 1.0E-08.

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

  • sgd.l2RegularizationAmount - 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, specify a small value, such as 1.0E-04 or 1.0E-08.

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

  • 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.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the model size might affect performance.

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

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *trainingParameters

Declared In

AWSMachineLearningModel.h