Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns an MLModel
that includes detailed metadata, and data source
information as well as the current status of the MLModel
.
GetMLModel
provides results in normal or verbose format.
See: AWS API Reference for GetMLModel.
- getMLModel :: Text -> GetMLModel
- data GetMLModel
- gmlmVerbose :: Lens' GetMLModel (Maybe Bool)
- gmlmMLModelId :: Lens' GetMLModel Text
- getMLModelResponse :: Int -> GetMLModelResponse
- data GetMLModelResponse
- gmlmrsStatus :: Lens' GetMLModelResponse (Maybe EntityStatus)
- gmlmrsLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime)
- gmlmrsTrainingParameters :: Lens' GetMLModelResponse (HashMap Text Text)
- gmlmrsScoreThresholdLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime)
- gmlmrsCreatedAt :: Lens' GetMLModelResponse (Maybe UTCTime)
- gmlmrsRecipe :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsInputDataLocationS3 :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsMLModelId :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsSizeInBytes :: Lens' GetMLModelResponse (Maybe Integer)
- gmlmrsSchema :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsScoreThreshold :: Lens' GetMLModelResponse (Maybe Double)
- gmlmrsCreatedByIAMUser :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsName :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsLogURI :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsEndpointInfo :: Lens' GetMLModelResponse (Maybe RealtimeEndpointInfo)
- gmlmrsTrainingDataSourceId :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsMessage :: Lens' GetMLModelResponse (Maybe Text)
- gmlmrsMLModelType :: Lens' GetMLModelResponse (Maybe MLModelType)
- gmlmrsResponseStatus :: Lens' GetMLModelResponse Int
Creating a Request
Creates a value of GetMLModel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetMLModel Source
See: getMLModel
smart constructor.
Request Lenses
gmlmVerbose :: Lens' GetMLModel (Maybe Bool) Source
Specifies whether the GetMLModel
operation should return Recipe
.
If true, Recipe
is returned.
If false, Recipe
is not returned.
gmlmMLModelId :: Lens' GetMLModel Text Source
The ID assigned to the MLModel
at creation.
Destructuring the Response
Creates a value of GetMLModelResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gmlmrsStatus
gmlmrsLastUpdatedAt
gmlmrsTrainingParameters
gmlmrsScoreThresholdLastUpdatedAt
gmlmrsCreatedAt
gmlmrsRecipe
gmlmrsInputDataLocationS3
gmlmrsMLModelId
gmlmrsSizeInBytes
gmlmrsSchema
gmlmrsScoreThreshold
gmlmrsCreatedByIAMUser
gmlmrsName
gmlmrsLogURI
gmlmrsEndpointInfo
gmlmrsTrainingDataSourceId
gmlmrsMessage
gmlmrsMLModelType
gmlmrsResponseStatus
data GetMLModelResponse Source
Represents the output of a GetMLModel operation, and provides detailed
information about a MLModel
.
See: getMLModelResponse
smart constructor.
Response Lenses
gmlmrsStatus :: Lens' GetMLModelResponse (Maybe EntityStatus) Source
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 aMLModel
.INPROGRESS
- The request is processing.FAILED
- The request did not run to completion. It is not usable.COMPLETED
- The request completed successfully.DELETED
- TheMLModel
is marked as deleted. It is not usable.
gmlmrsLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source
The time of the most recent edit to the MLModel
. The time is expressed
in epoch time.
gmlmrsTrainingParameters :: Lens' GetMLModelResponse (HashMap Text Text) Source
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.
gmlmrsScoreThresholdLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source
The time of the most recent edit to the ScoreThreshold
. The time is
expressed in epoch time.
gmlmrsCreatedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source
The time that the MLModel
was created. The time is expressed in epoch
time.
gmlmrsRecipe :: Lens' GetMLModelResponse (Maybe Text) Source
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.
gmlmrsInputDataLocationS3 :: Lens' GetMLModelResponse (Maybe Text) Source
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
gmlmrsMLModelId :: Lens' GetMLModelResponse (Maybe Text) Source
The MLModel ID which is same as the MLModelId
in the request.
gmlmrsSizeInBytes :: Lens' GetMLModelResponse (Maybe Integer) Source
Undocumented member.
gmlmrsSchema :: Lens' GetMLModelResponse (Maybe Text) Source
The schema used by all of the data files referenced by the DataSource
.
Note
This parameter is provided as part of the verbose format.
gmlmrsScoreThreshold :: Lens' GetMLModelResponse (Maybe Double) Source
The scoring threshold is used in binary classification MLModel
s, 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
.
gmlmrsCreatedByIAMUser :: Lens' GetMLModelResponse (Maybe Text) Source
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.
gmlmrsName :: Lens' GetMLModelResponse (Maybe Text) Source
A user-supplied name or description of the MLModel
.
gmlmrsLogURI :: Lens' GetMLModelResponse (Maybe Text) Source
A link to the file that contains logs of the CreateMLModel
operation.
gmlmrsEndpointInfo :: Lens' GetMLModelResponse (Maybe RealtimeEndpointInfo) Source
The current endpoint of the MLModel
gmlmrsTrainingDataSourceId :: Lens' GetMLModelResponse (Maybe Text) Source
The ID of the training DataSource
.
gmlmrsMessage :: Lens' GetMLModelResponse (Maybe Text) Source
Description of the most recent details about accessing the MLModel
.
gmlmrsMLModelType :: Lens' GetMLModelResponse (Maybe MLModelType) Source
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?"
gmlmrsResponseStatus :: Lens' GetMLModelResponse Int Source
The response status code.