| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MachineLearning.CreateEvaluation
Description
Creates a new Evaluation of an MLModel. An MLModel is evaluated on
a set of observations associated to a DataSource. Like a DataSource
for an MLModel, the DataSource for an Evaluation contains values
for the Target Variable. The Evaluation compares the predicted
result for each observation to the actual outcome and provides a summary
so that you know how effective the MLModel functions on the test data.
Evaluation generates a relevant performance metric, such as BinaryAUC,
RegressionRMSE or MulticlassAvgFScore based on the corresponding
MLModelType: BINARY, REGRESSION or MULTICLASS.
CreateEvaluation is an asynchronous operation. In response to
CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately
returns and sets the evaluation status to PENDING. After the
Evaluation is created and ready for use, Amazon ML sets the status to
COMPLETED.
You can use the GetEvaluation operation to check progress of the
evaluation during the creation operation.
Synopsis
- data CreateEvaluation = CreateEvaluation' {}
- newCreateEvaluation :: Text -> Text -> Text -> CreateEvaluation
- createEvaluation_evaluationName :: Lens' CreateEvaluation (Maybe Text)
- createEvaluation_evaluationId :: Lens' CreateEvaluation Text
- createEvaluation_mLModelId :: Lens' CreateEvaluation Text
- createEvaluation_evaluationDataSourceId :: Lens' CreateEvaluation Text
- data CreateEvaluationResponse = CreateEvaluationResponse' {
- evaluationId :: Maybe Text
- httpStatus :: Int
- newCreateEvaluationResponse :: Int -> CreateEvaluationResponse
- createEvaluationResponse_evaluationId :: Lens' CreateEvaluationResponse (Maybe Text)
- createEvaluationResponse_httpStatus :: Lens' CreateEvaluationResponse Int
Creating a Request
data CreateEvaluation Source #
See: newCreateEvaluation smart constructor.
Constructors
| CreateEvaluation' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateEvaluation |
Create a value of CreateEvaluation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationName:CreateEvaluation', createEvaluation_evaluationName - A user-supplied name or description of the Evaluation.
$sel:evaluationId:CreateEvaluation', createEvaluation_evaluationId - A user-supplied ID that uniquely identifies the Evaluation.
$sel:mLModelId:CreateEvaluation', createEvaluation_mLModelId - The ID of the MLModel to evaluate.
The schema used in creating the MLModel must match the schema of the
DataSource used in the Evaluation.
$sel:evaluationDataSourceId:CreateEvaluation', createEvaluation_evaluationDataSourceId - The ID of the DataSource for the evaluation. The schema of the
DataSource must match the schema used to create the MLModel.
Request Lenses
createEvaluation_evaluationName :: Lens' CreateEvaluation (Maybe Text) Source #
A user-supplied name or description of the Evaluation.
createEvaluation_evaluationId :: Lens' CreateEvaluation Text Source #
A user-supplied ID that uniquely identifies the Evaluation.
createEvaluation_mLModelId :: Lens' CreateEvaluation Text Source #
The ID of the MLModel to evaluate.
The schema used in creating the MLModel must match the schema of the
DataSource used in the Evaluation.
createEvaluation_evaluationDataSourceId :: Lens' CreateEvaluation Text Source #
The ID of the DataSource for the evaluation. The schema of the
DataSource must match the schema used to create the MLModel.
Destructuring the Response
data CreateEvaluationResponse Source #
Represents the output of a CreateEvaluation operation, and is an
acknowledgement that Amazon ML received the request.
CreateEvaluation operation is asynchronous. You can poll for status
updates by using the GetEvcaluation operation and checking the
Status parameter.
See: newCreateEvaluationResponse smart constructor.
Constructors
| CreateEvaluationResponse' | |
Fields
| |
Instances
newCreateEvaluationResponse Source #
Create a value of CreateEvaluationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationId:CreateEvaluation', createEvaluationResponse_evaluationId - The user-supplied ID that uniquely identifies the Evaluation. This
value should be identical to the value of the EvaluationId in the
request.
$sel:httpStatus:CreateEvaluationResponse', createEvaluationResponse_httpStatus - The response's http status code.
Response Lenses
createEvaluationResponse_evaluationId :: Lens' CreateEvaluationResponse (Maybe Text) Source #
The user-supplied ID that uniquely identifies the Evaluation. This
value should be identical to the value of the EvaluationId in the
request.
createEvaluationResponse_httpStatus :: Lens' CreateEvaluationResponse Int Source #
The response's http status code.