public class Evaluation extends Object implements Serializable, Cloneable
Represents the output of GetEvaluation operation.
The content consists of the detailed metadata and data file
information and the current status of the Evaluation .
| Constructor and Description |
|---|
Evaluation() |
| Modifier and Type | Method and Description |
|---|---|
Evaluation |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedAt()
The time that the
Evaluation was created. |
String |
getCreatedByIamUser()
The AWS user account that invoked the evaluation.
|
String |
getEvaluationDataSourceId()
The ID of the
DataSource that is used to evaluate the
MLModel. |
String |
getEvaluationId()
The ID that is assigned to the
Evaluation at creation. |
String |
getInputDataLocationS3()
The location and name of the data in Amazon Simple Storage Server
(Amazon S3) that is used in the evaluation.
|
Date |
getLastUpdatedAt()
The time of the most recent edit to the
Evaluation. |
String |
getMessage()
A description of the most recent details about evaluating the
MLModel. |
String |
getMLModelId()
The ID of the
MLModel that is the focus of the
evaluation. |
String |
getName()
A user-supplied name or description of the
Evaluation. |
PerformanceMetrics |
getPerformanceMetrics()
Measurements of how well the
MLModel performed, using
observations referenced by the DataSource. |
String |
getStatus()
The status of the evaluation.
|
int |
hashCode() |
void |
setCreatedAt(Date createdAt)
The time that the
Evaluation was created. |
void |
setCreatedByIamUser(String createdByIamUser)
The AWS user account that invoked the evaluation.
|
void |
setEvaluationDataSourceId(String evaluationDataSourceId)
The ID of the
DataSource that is used to evaluate the
MLModel. |
void |
setEvaluationId(String evaluationId)
The ID that is assigned to the
Evaluation at creation. |
void |
setInputDataLocationS3(String inputDataLocationS3)
The location and name of the data in Amazon Simple Storage Server
(Amazon S3) that is used in the evaluation.
|
void |
setLastUpdatedAt(Date lastUpdatedAt)
The time of the most recent edit to the
Evaluation. |
void |
setMessage(String message)
A description of the most recent details about evaluating the
MLModel. |
void |
setMLModelId(String mLModelId)
The ID of the
MLModel that is the focus of the
evaluation. |
void |
setName(String name)
A user-supplied name or description of the
Evaluation. |
void |
setPerformanceMetrics(PerformanceMetrics performanceMetrics)
Measurements of how well the
MLModel performed, using
observations referenced by the DataSource. |
void |
setStatus(EntityStatus status)
The status of the evaluation.
|
void |
setStatus(String status)
The status of the evaluation.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Evaluation |
withCreatedAt(Date createdAt)
The time that the
Evaluation was created. |
Evaluation |
withCreatedByIamUser(String createdByIamUser)
The AWS user account that invoked the evaluation.
|
Evaluation |
withEvaluationDataSourceId(String evaluationDataSourceId)
The ID of the
DataSource that is used to evaluate the
MLModel. |
Evaluation |
withEvaluationId(String evaluationId)
The ID that is assigned to the
Evaluation at creation. |
Evaluation |
withInputDataLocationS3(String inputDataLocationS3)
The location and name of the data in Amazon Simple Storage Server
(Amazon S3) that is used in the evaluation.
|
Evaluation |
withLastUpdatedAt(Date lastUpdatedAt)
The time of the most recent edit to the
Evaluation. |
Evaluation |
withMessage(String message)
A description of the most recent details about evaluating the
MLModel. |
Evaluation |
withMLModelId(String mLModelId)
The ID of the
MLModel that is the focus of the
evaluation. |
Evaluation |
withName(String name)
A user-supplied name or description of the
Evaluation. |
Evaluation |
withPerformanceMetrics(PerformanceMetrics performanceMetrics)
Measurements of how well the
MLModel performed, using
observations referenced by the DataSource. |
Evaluation |
withStatus(EntityStatus status)
The status of the evaluation.
|
Evaluation |
withStatus(String status)
The status of the evaluation.
|
public String getEvaluationId()
Evaluation at creation.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
Evaluation at creation.public void setEvaluationId(String evaluationId)
Evaluation at creation.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
evaluationId - The ID that is assigned to the Evaluation at creation.public Evaluation withEvaluationId(String evaluationId)
Evaluation at creation.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
evaluationId - The ID that is assigned to the Evaluation at creation.public String getMLModelId()
MLModel that is the focus of the
evaluation.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
MLModel that is the focus of the
evaluation.public void setMLModelId(String mLModelId)
MLModel that is the focus of the
evaluation.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
mLModelId - The ID of the MLModel that is the focus of the
evaluation.public Evaluation withMLModelId(String mLModelId)
MLModel that is the focus of the
evaluation.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
mLModelId - The ID of the MLModel that is the focus of the
evaluation.public String getEvaluationDataSourceId()
DataSource that is used to evaluate the
MLModel.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
DataSource that is used to evaluate the
MLModel.public void setEvaluationDataSourceId(String evaluationDataSourceId)
DataSource that is used to evaluate the
MLModel.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
evaluationDataSourceId - The ID of the DataSource that is used to evaluate the
MLModel.public Evaluation withEvaluationDataSourceId(String evaluationDataSourceId)
DataSource that is used to evaluate the
MLModel.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
evaluationDataSourceId - The ID of the DataSource that is used to evaluate the
MLModel.public String getInputDataLocationS3()
Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?
public void setInputDataLocationS3(String inputDataLocationS3)
Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?
inputDataLocationS3 - The location and name of the data in Amazon Simple Storage Server
(Amazon S3) that is used in the evaluation.public Evaluation withInputDataLocationS3(String inputDataLocationS3)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?
inputDataLocationS3 - The location and name of the data in Amazon Simple Storage Server
(Amazon S3) that is used in the evaluation.public String getCreatedByIamUser()
Constraints:
Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
public void setCreatedByIamUser(String createdByIamUser)
Constraints:
Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
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.public Evaluation withCreatedByIamUser(String createdByIamUser)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
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.public Date getCreatedAt()
Evaluation was created. The time is
expressed in epoch time.Evaluation was created. The time is
expressed in epoch time.public void setCreatedAt(Date createdAt)
Evaluation was created. The time is
expressed in epoch time.createdAt - The time that the Evaluation was created. The time is
expressed in epoch time.public Evaluation withCreatedAt(Date createdAt)
Evaluation was created. The time is
expressed in epoch time.
Returns a reference to this object so that method calls can be chained together.
createdAt - The time that the Evaluation was created. The time is
expressed in epoch time.public Date getLastUpdatedAt()
Evaluation. The
time is expressed in epoch time.Evaluation. The
time is expressed in epoch time.public void setLastUpdatedAt(Date lastUpdatedAt)
Evaluation. The
time is expressed in epoch time.lastUpdatedAt - The time of the most recent edit to the Evaluation. The
time is expressed in epoch time.public Evaluation withLastUpdatedAt(Date lastUpdatedAt)
Evaluation. The
time is expressed in epoch time.
Returns a reference to this object so that method calls can be chained together.
lastUpdatedAt - The time of the most recent edit to the Evaluation. The
time is expressed in epoch time.public String getName()
Evaluation.
Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$
Evaluation.public void setName(String name)
Evaluation.
Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$
name - A user-supplied name or description of the Evaluation.public Evaluation withName(String name)
Evaluation.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$
name - A user-supplied name or description of the Evaluation.public String getStatus()
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.
Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
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.EntityStatuspublic void setStatus(String status)
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.
Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
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.EntityStatuspublic Evaluation withStatus(String status)
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.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
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.EntityStatuspublic void setStatus(EntityStatus status)
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.
Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
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.EntityStatuspublic Evaluation withStatus(EntityStatus status)
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.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
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.EntityStatuspublic PerformanceMetrics getPerformanceMetrics()
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.
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.
public void setPerformanceMetrics(PerformanceMetrics performanceMetrics)
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.
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.
public Evaluation withPerformanceMetrics(PerformanceMetrics performanceMetrics)
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.
Returns a reference to this object so that method calls can be chained together.
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.
public String getMessage()
MLModel.
Constraints:
Length: 0 - 10240
MLModel.public void setMessage(String message)
MLModel.
Constraints:
Length: 0 - 10240
message - A description of the most recent details about evaluating the
MLModel.public Evaluation withMessage(String message)
MLModel.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10240
message - A description of the most recent details about evaluating the
MLModel.public String toString()
toString in class ObjectObject.toString()public Evaluation clone()
Copyright © 2015. All rights reserved.