libZSservicesZSamazonka-mlZSamazonka-ml
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MachineLearning.Types.Evaluation

Description

 
Synopsis

Documentation

data Evaluation Source #

Represents the output of GetEvaluation operation.

The content consists of the detailed metadata and data file information and the current status of the Evaluation.

See: newEvaluation smart constructor.

Constructors

Evaluation' 

Fields

  • status :: Maybe EntityStatus

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

    • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.
    • INPROGRESS - The evaluation is underway.
    • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
    • COMPLETED - The evaluation process completed successfully.
    • DELETED - The Evaluation is marked as deleted. It is not usable.
  • performanceMetrics :: Maybe PerformanceMetrics

    Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:

    • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
    • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
    • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

    For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

  • lastUpdatedAt :: Maybe POSIX

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

  • createdAt :: Maybe POSIX

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

  • computeTime :: Maybe Integer
     
  • inputDataLocationS3 :: Maybe Text

    The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

  • mLModelId :: Maybe Text

    The ID of the MLModel that is the focus of the evaluation.

  • startedAt :: Maybe POSIX
     
  • finishedAt :: Maybe POSIX
     
  • createdByIamUser :: Maybe Text

    The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

  • name :: Maybe Text

    A user-supplied name or description of the Evaluation.

  • evaluationId :: Maybe Text

    The ID that is assigned to the Evaluation at creation.

  • message :: Maybe Text

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

  • evaluationDataSourceId :: Maybe Text

    The ID of the DataSource that is used to evaluate the MLModel.

Instances

Instances details
Eq Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

Read Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

Show Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

Generic Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

Associated Types

type Rep Evaluation :: Type -> Type #

NFData Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

Methods

rnf :: Evaluation -> () #

Hashable Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

FromJSON Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

type Rep Evaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.Evaluation

type Rep Evaluation = D1 ('MetaData "Evaluation" "Amazonka.MachineLearning.Types.Evaluation" "libZSservicesZSamazonka-mlZSamazonka-ml" 'False) (C1 ('MetaCons "Evaluation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityStatus)) :*: (S1 ('MetaSel ('Just "performanceMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PerformanceMetrics)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "computeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "inputDataLocationS3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mLModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "finishedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "createdByIamUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evaluationDataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newEvaluation :: Evaluation Source #

Create a value of Evaluation 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:status:Evaluation', evaluation_status - The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.
  • INPROGRESS - The evaluation is underway.
  • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
  • COMPLETED - The evaluation process completed successfully.
  • DELETED - The Evaluation is marked as deleted. It is not usable.

$sel:performanceMetrics:Evaluation', evaluation_performanceMetrics - Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:

  • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
  • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
  • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

$sel:lastUpdatedAt:Evaluation', evaluation_lastUpdatedAt - The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

$sel:createdAt:Evaluation', evaluation_createdAt - The time that the Evaluation was created. The time is expressed in epoch time.

$sel:computeTime:Evaluation', evaluation_computeTime - Undocumented member.

$sel:inputDataLocationS3:Evaluation', evaluation_inputDataLocationS3 - The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

$sel:mLModelId:Evaluation', evaluation_mLModelId - The ID of the MLModel that is the focus of the evaluation.

$sel:startedAt:Evaluation', evaluation_startedAt - Undocumented member.

$sel:finishedAt:Evaluation', evaluation_finishedAt - Undocumented member.

$sel:createdByIamUser:Evaluation', evaluation_createdByIamUser - The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

$sel:name:Evaluation', evaluation_name - A user-supplied name or description of the Evaluation.

$sel:evaluationId:Evaluation', evaluation_evaluationId - The ID that is assigned to the Evaluation at creation.

$sel:message:Evaluation', evaluation_message - A description of the most recent details about evaluating the MLModel.

$sel:evaluationDataSourceId:Evaluation', evaluation_evaluationDataSourceId - The ID of the DataSource that is used to evaluate the MLModel.

evaluation_status :: Lens' Evaluation (Maybe EntityStatus) Source #

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

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.
  • INPROGRESS - The evaluation is underway.
  • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
  • COMPLETED - The evaluation process completed successfully.
  • DELETED - The Evaluation is marked as deleted. It is not usable.

evaluation_performanceMetrics :: Lens' Evaluation (Maybe PerformanceMetrics) Source #

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:

  • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
  • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
  • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

evaluation_lastUpdatedAt :: Lens' Evaluation (Maybe UTCTime) Source #

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

evaluation_createdAt :: Lens' Evaluation (Maybe UTCTime) Source #

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

evaluation_inputDataLocationS3 :: Lens' Evaluation (Maybe Text) Source #

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

evaluation_mLModelId :: Lens' Evaluation (Maybe Text) Source #

The ID of the MLModel that is the focus of the evaluation.

evaluation_createdByIamUser :: Lens' Evaluation (Maybe Text) Source #

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

evaluation_name :: Lens' Evaluation (Maybe Text) Source #

A user-supplied name or description of the Evaluation.

evaluation_evaluationId :: Lens' Evaluation (Maybe Text) Source #

The ID that is assigned to the Evaluation at creation.

evaluation_message :: Lens' Evaluation (Maybe Text) Source #

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

evaluation_evaluationDataSourceId :: Lens' Evaluation (Maybe Text) Source #

The ID of the DataSource that is used to evaluate the MLModel.