/* * Copyright 2010-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.machinelearning.model; import java.io.Serializable; /** *
* Represents the output of a GetMLModel
operation, and provides
* detailed information about a MLModel
.
*
* The MLModel ID, which is same as the MLModelId
in the
* request.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*/
private String mLModelId;
/**
*
* The ID of the training DataSource
.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*/
private String trainingDataSourceId;
/**
*
* 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.
*
* Constraints:
* Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
*/
private String createdByIamUser;
/**
*
* The time that the MLModel
was created. The time is expressed
* in epoch time.
*
* The time of the most recent edit to the MLModel
. The time is
* expressed in epoch time.
*
* A user-supplied name or description of the MLModel
.
*
* Constraints:
* Length: - 1024
*/
private String name;
/**
*
* 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. The ML model
* isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as deleted. It
* isn't usable.
*
* Constraints:
* Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
*/
private String status;
/**
*
* Long integer type that is a 64-bit signed number. *
*/ private Long sizeInBytes; /** *
* The current endpoint of the MLModel
*
* 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.maxMLModelSizeInBytes
- The maximum allowed size of the
* model. Depending on the input data, the size of the model might affect
* its performance.
*
* The value is an integer that ranges from 100000
to
* 2147483648
. The default value is 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the training
* data. Shuffling data improves a model's ability to find the optimal
* solution for a variety of data types. The valid values are
* auto
and none
. The default value is
* none
. We strongly recommend that you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a
* small value, such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1 normalization. This
* parameter can't be used when L2
is specified. Use this
* parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2 normalization. This
* parameter can't be used when L1
is specified. Use this
* parameter sparingly.
*
* The location of the data file or directory in Amazon Simple Storage * Service (Amazon S3). *
*
* Constraints:
* Length: - 2048
* Pattern: s3://([^/]+)(/.*)?
*/
private String inputDataLocationS3;
/**
*
* Identifies the MLModel
category. The following are the
* available types:
*
* REGRESSION -- Produces a numeric result. For example, * "What price should a house be listed at?" *
** BINARY -- Produces one of two possible results. For example, * "Is this an e-commerce website?" *
** MULTICLASS -- Produces one of several possible results. For example, * "Is this a HIGH, LOW or MEDIUM risk trade?" *
*
* Constraints:
* Allowed Values: REGRESSION, BINARY, MULTICLASS
*/
private String mLModelType;
/**
*
* The scoring threshold is used in binary classification
* MLModel
models. It 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
.
*
* The time of the most recent edit to the ScoreThreshold
. The
* time is expressed in epoch time.
*
* A link to the file that contains logs of the CreateMLModel
* operation.
*
* A description of the most recent details about accessing the
* MLModel
.
*
* Constraints:
* Length: - 10240
*/
private String message;
/**
*
* The approximate CPU time in milliseconds that Amazon Machine Learning
* spent processing the MLModel
, normalized and scaled on
* computation resources. ComputeTime
is only available if the
* MLModel
is in the COMPLETED
state.
*
* The epoch time when Amazon Machine Learning marked the
* MLModel
as COMPLETED
or FAILED
.
* FinishedAt
is only available when the MLModel
* is in the COMPLETED
or FAILED
state.
*
* The epoch time when Amazon Machine Learning marked the
* MLModel
as INPROGRESS
. StartedAt
* isn't available if the MLModel
is in the
* PENDING
state.
*
* The recipe to use when training the MLModel
. The
* Recipe
provides detailed information about the observation
* data to use during training, and manipulations to perform on the
* observation data during training.
*
* Note: This parameter is provided as part of the verbose format. *
*
* Constraints:
* Length: - 131071
*/
private String recipe;
/**
*
* The schema used by all of the data files referenced by the
* DataSource
.
*
* Note: This parameter is provided as part of the verbose format. *
*
* Constraints:
* Length: - 131071
*/
private String schema;
/**
*
* The MLModel ID, which is same as the MLModelId
in the
* request.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*
* @return
* The MLModel ID, which is same as the MLModelId
in
* the request.
*
* The MLModel ID, which is same as the MLModelId
in the
* request.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*
* @param mLModelId
* The MLModel ID, which is same as the MLModelId
in
* the request.
*
* The MLModel ID, which is same as the MLModelId
in the
* request.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*
* @param mLModelId
* The MLModel ID, which is same as the MLModelId
in
* the request.
*
* The ID of the training DataSource
.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*
* @return
* The ID of the training DataSource
.
*
* The ID of the training DataSource
.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*
* @param trainingDataSourceId
* The ID of the training DataSource
.
*
* The ID of the training DataSource
.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.-]+
*
* @param trainingDataSourceId
* The ID of the training DataSource
.
*
* 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.
*
* Constraints:
* Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
*
* @return
* 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.
*
* 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.
*
* Constraints:
* Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
*
* @param 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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
*
* @param 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.
*
* The time that the MLModel
was created. The time is expressed
* in epoch time.
*
* The time that the MLModel
was created. The time is
* expressed in epoch time.
*
* The time that the MLModel
was created. The time is expressed
* in epoch time.
*
* The time that the MLModel
was created. The time
* is expressed in epoch time.
*
* The time that the MLModel
was created. The time is expressed
* in epoch time.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param createdAt
* The time that the MLModel
was created. The time
* is expressed in epoch time.
*
* The time of the most recent edit to the MLModel
. The time is
* expressed in epoch time.
*
* The time of the most recent edit to the MLModel
. The
* time is expressed in epoch time.
*
* The time of the most recent edit to the MLModel
. The time is
* expressed in epoch time.
*
* The time of the most recent edit to the MLModel
.
* The time is expressed in epoch time.
*
* The time of the most recent edit to the MLModel
. The time is
* expressed in epoch time.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param lastUpdatedAt
* The time of the most recent edit to the MLModel
.
* The time is expressed in epoch time.
*
* A user-supplied name or description of the MLModel
.
*
* Constraints:
* Length: - 1024
*
* @return
* A user-supplied name or description of the MLModel
.
*
* A user-supplied name or description of the MLModel
.
*
* Constraints:
* Length: - 1024
*
* @param name
* A user-supplied name or description of the
* MLModel
.
*
* A user-supplied name or description of the MLModel
.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 1024
*
* @param name
* A user-supplied name or description of the
* MLModel
.
*
* 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. The ML model
* isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as deleted. It
* isn't usable.
*
* Constraints:
* Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
*
* @return
* 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. The
* ML model isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as
* deleted. It isn't usable.
*
* 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. The ML model
* isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as deleted. It
* isn't usable.
*
* Constraints:
* Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
*
* @param 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.
* The ML model isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as
* deleted. It isn't usable.
*
* 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. The ML model
* isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as deleted. It
* isn't usable.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
*
* @param 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.
* The ML model isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as
* deleted. It isn't usable.
*
* 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. The ML model
* isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as deleted. It
* isn't usable.
*
* Constraints:
* Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
*
* @param 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.
* The ML model isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as
* deleted. It isn't usable.
*
* 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. The ML model
* isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as deleted. It
* isn't usable.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
*
* @param 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.
* The ML model isn't usable.
*
* COMPLETED
- The request completed successfully.
*
* DELETED
- The MLModel
is marked as
* deleted. It isn't usable.
*
* Long integer type that is a 64-bit signed number. *
* * @return* Long integer type that is a 64-bit signed number. *
*/ public Long getSizeInBytes() { return sizeInBytes; } /** ** Long integer type that is a 64-bit signed number. *
* * @param sizeInBytes* Long integer type that is a 64-bit signed number. *
*/ public void setSizeInBytes(Long sizeInBytes) { this.sizeInBytes = sizeInBytes; } /** ** Long integer type that is a 64-bit signed number. *
** Returns a reference to this object so that method calls can be chained * together. * * @param sizeInBytes
* Long integer type that is a 64-bit signed number. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMLModelResult withSizeInBytes(Long sizeInBytes) { this.sizeInBytes = sizeInBytes; return this; } /** *
* The current endpoint of the MLModel
*
* The current endpoint of the MLModel
*
* The current endpoint of the MLModel
*
* The current endpoint of the MLModel
*
* The current endpoint of the MLModel
*
* Returns a reference to this object so that method calls can be chained * together. * * @param endpointInfo
* The current endpoint of the MLModel
*
* 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.maxMLModelSizeInBytes
- The maximum allowed size of the
* model. Depending on the input data, the size of the model might affect
* its performance.
*
* The value is an integer that ranges from 100000
to
* 2147483648
. The default value is 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the training
* data. Shuffling data improves a model's ability to find the optimal
* solution for a variety of data types. The valid values are
* auto
and none
. The default value is
* none
. We strongly recommend that you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a
* small value, such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1 normalization. This
* parameter can't be used when L2
is specified. Use this
* parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2 normalization. This
* parameter can't be used when L1
is specified. Use this
* parameter sparingly.
*
* 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.maxMLModelSizeInBytes
- The maximum allowed size
* of the model. Depending on the input data, the size of the model
* might affect its performance.
*
* The value is an integer that ranges from 100000
to
* 2147483648
. The default value is
* 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the
* training data. Shuffling data improves a model's ability to find
* the optimal solution for a variety of data types. The valid
* values are auto
and none
. The default
* value is none
. We strongly recommend that you
* shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1
* normalization. This parameter can't be used when L2
* is specified. Use this parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by
* specifying a small value, such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2
* normalization. This parameter can't be used when L1
* is specified. Use this parameter sparingly.
*
* 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.maxMLModelSizeInBytes
- The maximum allowed size of the
* model. Depending on the input data, the size of the model might affect
* its performance.
*
* The value is an integer that ranges from 100000
to
* 2147483648
. The default value is 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the training
* data. Shuffling data improves a model's ability to find the optimal
* solution for a variety of data types. The valid values are
* auto
and none
. The default value is
* none
. We strongly recommend that you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a
* small value, such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1 normalization. This
* parameter can't be used when L2
is specified. Use this
* parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2 normalization. This
* parameter can't be used when L1
is specified. Use this
* parameter sparingly.
*
* 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.maxMLModelSizeInBytes
- The maximum allowed
* size of the model. Depending on the input data, the size of
* the model might affect its performance.
*
* The value is an integer that ranges from 100000
* to 2147483648
. The default value is
* 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the
* training data. Shuffling data improves a model's ability to
* find the optimal solution for a variety of data types. The
* valid values are auto
and none
. The
* default value is none
. We strongly recommend that
* you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a small value,
* such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1
* normalization. This parameter can't be used when
* L2
is specified. Use this parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2
* normalization. This parameter can't be used when
* L1
is specified. Use this parameter sparingly.
*
* 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.maxMLModelSizeInBytes
- The maximum allowed size of the
* model. Depending on the input data, the size of the model might affect
* its performance.
*
* The value is an integer that ranges from 100000
to
* 2147483648
. The default value is 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the training
* data. Shuffling data improves a model's ability to find the optimal
* solution for a variety of data types. The valid values are
* auto
and none
. The default value is
* none
. We strongly recommend that you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a
* small value, such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1 normalization. This
* parameter can't be used when L2
is specified. Use this
* parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2 normalization. This
* parameter can't be used when L1
is specified. Use this
* parameter sparingly.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param 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.maxMLModelSizeInBytes
- The maximum allowed
* size of the model. Depending on the input data, the size of
* the model might affect its performance.
*
* The value is an integer that ranges from 100000
* to 2147483648
. The default value is
* 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the
* training data. Shuffling data improves a model's ability to
* find the optimal solution for a variety of data types. The
* valid values are auto
and none
. The
* default value is none
. We strongly recommend that
* you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a small value,
* such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1
* normalization. This parameter can't be used when
* L2
is specified. Use this parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2
* normalization. This parameter can't be used when
* L1
is specified. Use this parameter sparingly.
*
* 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.maxMLModelSizeInBytes
- The maximum allowed size of the
* model. Depending on the input data, the size of the model might affect
* its performance.
*
* The value is an integer that ranges from 100000
to
* 2147483648
. The default value is 33554432
.
*
* 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.shuffleType
- Whether Amazon ML shuffles the training
* data. Shuffling data improves a model's ability to find the optimal
* solution for a variety of data types. The valid values are
* auto
and none
. The default value is
* none
. We strongly recommend that you shuffle your data.
*
* sgd.l1RegularizationAmount
- The 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, start by specifying a
* small value, such as 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L1 normalization. This
* parameter can't be used when L2
is specified. Use this
* parameter sparingly.
*
* sgd.l2RegularizationAmount
- The 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, start by specifying a small value, such as
* 1.0E-08
.
*
* The value is a double that ranges from 0
to
* MAX_DOUBLE
. The default is to not use L2 normalization. This
* parameter can't be used when L1
is specified. Use this
* parameter sparingly.
*
* The method adds a new key-value pair into TrainingParameters parameter,
* and returns a reference to this object so that method calls can be
* chained together.
*
* @param key The key of the entry to be added into TrainingParameters.
* @param value The corresponding value of the entry to be added into
* TrainingParameters.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GetMLModelResult addTrainingParametersEntry(String key, String value) {
if (null == this.trainingParameters) {
this.trainingParameters = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public GetMLModelResult clearTrainingParametersEntries() {
this.trainingParameters = null;
return this;
}
/**
*
* The location of the data file or directory in Amazon Simple Storage
* Service (Amazon S3).
*
* Constraints:
* The location of the data file or directory in Amazon Simple
* Storage Service (Amazon S3).
*
* The location of the data file or directory in Amazon Simple Storage
* Service (Amazon S3).
*
* Constraints:
* The location of the data file or directory in Amazon Simple
* Storage Service (Amazon S3).
*
* The location of the data file or directory in Amazon Simple Storage
* Service (Amazon S3).
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* The location of the data file or directory in Amazon Simple
* Storage Service (Amazon S3).
*
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For example,
* "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Constraints:
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For
* example, "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For example,
* "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Constraints:
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For
* example, "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For example,
* "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For
* example, "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For example,
* "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Constraints:
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For
* example, "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For example,
* "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Identifies the
* REGRESSION -- Produces a numeric result. For example,
* "What price should a house be listed at?"
*
* BINARY -- Produces one of two possible results. For example,
* "Is this an e-commerce website?"
*
* MULTICLASS -- Produces one of several possible results. For
* example, "Is this a HIGH, LOW or MEDIUM risk trade?"
*
* The scoring threshold is used in binary classification
*
* Output values greater than or equal to the threshold receive a positive
* result from the MLModel, such as
* The scoring threshold is used in binary classification
*
* Output values greater than or equal to the threshold receive a
* positive result from the MLModel, such as
* The scoring threshold is used in binary classification
*
* Output values greater than or equal to the threshold receive a positive
* result from the MLModel, such as
* The scoring threshold is used in binary classification
*
* Output values greater than or equal to the threshold receive a
* positive result from the MLModel, such as
* The scoring threshold is used in binary classification
*
* Output values greater than or equal to the threshold receive a positive
* result from the MLModel, such as
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param scoreThreshold
* The scoring threshold is used in binary classification
*
* Output values greater than or equal to the threshold receive a
* positive result from the MLModel, such as
* The time of the most recent edit to the
* The time of the most recent edit to the
*
* The time of the most recent edit to the
* The time of the most recent edit to the
*
* The time of the most recent edit to the
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param scoreThresholdLastUpdatedAt
* The time of the most recent edit to the
*
* A link to the file that contains logs of the
* A link to the file that contains logs of the
*
* A link to the file that contains logs of the
* A link to the file that contains logs of the
*
* A link to the file that contains logs of the
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param logUri
* A link to the file that contains logs of the
*
* A description of the most recent details about accessing the
*
* Constraints:
* A description of the most recent details about accessing the
*
* A description of the most recent details about accessing the
*
* Constraints:
* A description of the most recent details about accessing the
*
* A description of the most recent details about accessing the
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* A description of the most recent details about accessing the
*
* The approximate CPU time in milliseconds that Amazon Machine Learning
* spent processing the
* The approximate CPU time in milliseconds that Amazon Machine
* Learning spent processing the
* The approximate CPU time in milliseconds that Amazon Machine Learning
* spent processing the
* The approximate CPU time in milliseconds that Amazon Machine
* Learning spent processing the
* The approximate CPU time in milliseconds that Amazon Machine Learning
* spent processing the
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param computeTime
* The approximate CPU time in milliseconds that Amazon Machine
* Learning spent processing the
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param finishedAt
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* The epoch time when Amazon Machine Learning marked the
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param startedAt
* The epoch time when Amazon Machine Learning marked the
*
* The recipe to use when training the
* Note: This parameter is provided as part of the verbose format.
*
* Constraints:
* The recipe to use when training the
* Note: This parameter is provided as part of the verbose
* format.
*
* The recipe to use when training the
* Note: This parameter is provided as part of the verbose format.
*
* Constraints:
* The recipe to use when training the
* Note: This parameter is provided as part of the verbose
* format.
*
* The recipe to use when training the
* Note: This parameter is provided as part of the verbose format.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* The recipe to use when training the
* Note: This parameter is provided as part of the verbose
* format.
*
* The schema used by all of the data files referenced by the
*
* Note: This parameter is provided as part of the verbose format.
*
* Constraints:
* The schema used by all of the data files referenced by the
*
* Note: This parameter is provided as part of the verbose
* format.
*
* The schema used by all of the data files referenced by the
*
* Note: This parameter is provided as part of the verbose format.
*
* Constraints:
* The schema used by all of the data files referenced by the
*
* Note: This parameter is provided as part of the verbose
* format.
*
* The schema used by all of the data files referenced by the
*
* Note: This parameter is provided as part of the verbose format.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* The schema used by all of the data files referenced by the
*
* Note: This parameter is provided as part of the verbose
* format.
*
* Length: - 2048
* Pattern: s3://([^/]+)(/.*)?
*
* @return
* Length: - 2048
* Pattern: s3://([^/]+)(/.*)?
*
* @param inputDataLocationS3
* Length: - 2048
* Pattern: s3://([^/]+)(/.*)?
*
* @param inputDataLocationS3 MLModel
category. The following are the
* available types:
*
*
*
* Allowed Values: REGRESSION, BINARY, MULTICLASS
*
* @return MLModel
category. The following are
* the available types:
*
*
* @see MLModelType
*/
public String getMLModelType() {
return mLModelType;
}
/**
* MLModel
category. The following are the
* available types:
*
*
*
* Allowed Values: REGRESSION, BINARY, MULTICLASS
*
* @param mLModelType MLModel
category. The following
* are the available types:
*
*
* @see MLModelType
*/
public void setMLModelType(String mLModelType) {
this.mLModelType = mLModelType;
}
/**
* MLModel
category. The following are the
* available types:
*
*
*
* Allowed Values: REGRESSION, BINARY, MULTICLASS
*
* @param mLModelType MLModel
category. The following
* are the available types:
*
*
* @return A reference to this updated object so that method calls can be
* chained together.
* @see MLModelType
*/
public GetMLModelResult withMLModelType(String mLModelType) {
this.mLModelType = mLModelType;
return this;
}
/**
* MLModel
category. The following are the
* available types:
*
*
*
* Allowed Values: REGRESSION, BINARY, MULTICLASS
*
* @param mLModelType MLModel
category. The following
* are the available types:
*
*
* @see MLModelType
*/
public void setMLModelType(MLModelType mLModelType) {
this.mLModelType = mLModelType.toString();
}
/**
* MLModel
category. The following are the
* available types:
*
*
*
* Allowed Values: REGRESSION, BINARY, MULTICLASS
*
* @param mLModelType MLModel
category. The following
* are the available types:
*
*
* @return A reference to this updated object so that method calls can be
* chained together.
* @see MLModelType
*/
public GetMLModelResult withMLModelType(MLModelType mLModelType) {
this.mLModelType = mLModelType.toString();
return this;
}
/**
* MLModel
models. It marks the boundary between a positive
* prediction and a negative prediction.
* true
. Output values less
* than the threshold receive a negative response from the MLModel, such as
* false
.
* MLModel
models. It marks the boundary between a
* positive prediction and a negative prediction.
* true
.
* Output values less than the threshold receive a negative response
* from the MLModel, such as false
.
* MLModel
models. It marks the boundary between a positive
* prediction and a negative prediction.
* true
. Output values less
* than the threshold receive a negative response from the MLModel, such as
* false
.
* MLModel
models. It marks the boundary between a
* positive prediction and a negative prediction.
* true
.
* Output values less than the threshold receive a negative
* response from the MLModel, such as false
.
* MLModel
models. It marks the boundary between a positive
* prediction and a negative prediction.
* true
. Output values less
* than the threshold receive a negative response from the MLModel, such as
* false
.
* MLModel
models. It marks the boundary between a
* positive prediction and a negative prediction.
* true
.
* Output values less than the threshold receive a negative
* response from the MLModel, such as false
.
* ScoreThreshold
. The
* time is expressed in epoch time.
* ScoreThreshold
. The time is expressed in epoch time.
* ScoreThreshold
. The
* time is expressed in epoch time.
* ScoreThreshold
. The time is expressed in epoch
* time.
* ScoreThreshold
. The
* time is expressed in epoch time.
* ScoreThreshold
. The time is expressed in epoch
* time.
* CreateMLModel
* operation.
* CreateMLModel
operation.
* CreateMLModel
* operation.
* CreateMLModel
operation.
* CreateMLModel
* operation.
* CreateMLModel
operation.
* MLModel
.
*
* Length: - 10240
*
* @return MLModel
.
* MLModel
.
*
* Length: - 10240
*
* @param message MLModel
.
* MLModel
.
*
* Length: - 10240
*
* @param message MLModel
.
* MLModel
, normalized and scaled on
* computation resources. ComputeTime
is only available if the
* MLModel
is in the COMPLETED
state.
* MLModel
, normalized
* and scaled on computation resources. ComputeTime
is
* only available if the MLModel
is in the
* COMPLETED
state.
* MLModel
, normalized and scaled on
* computation resources. ComputeTime
is only available if the
* MLModel
is in the COMPLETED
state.
* MLModel
, normalized
* and scaled on computation resources. ComputeTime
* is only available if the MLModel
is in the
* COMPLETED
state.
* MLModel
, normalized and scaled on
* computation resources. ComputeTime
is only available if the
* MLModel
is in the COMPLETED
state.
* MLModel
, normalized
* and scaled on computation resources. ComputeTime
* is only available if the MLModel
is in the
* COMPLETED
state.
* MLModel
as COMPLETED
or FAILED
.
* FinishedAt
is only available when the MLModel
* is in the COMPLETED
or FAILED
state.
* MLModel
as COMPLETED
or
* FAILED
. FinishedAt
is only available
* when the MLModel
is in the COMPLETED
or
* FAILED
state.
* MLModel
as COMPLETED
or FAILED
.
* FinishedAt
is only available when the MLModel
* is in the COMPLETED
or FAILED
state.
* MLModel
as COMPLETED
or
* FAILED
. FinishedAt
is only available
* when the MLModel
is in the COMPLETED
* or FAILED
state.
* MLModel
as COMPLETED
or FAILED
.
* FinishedAt
is only available when the MLModel
* is in the COMPLETED
or FAILED
state.
* MLModel
as COMPLETED
or
* FAILED
. FinishedAt
is only available
* when the MLModel
is in the COMPLETED
* or FAILED
state.
* MLModel
as INPROGRESS
. StartedAt
* isn't available if the MLModel
is in the
* PENDING
state.
* MLModel
as INPROGRESS
.
* StartedAt
isn't available if the
* MLModel
is in the PENDING
state.
* MLModel
as INPROGRESS
. StartedAt
* isn't available if the MLModel
is in the
* PENDING
state.
* MLModel
as INPROGRESS
.
* StartedAt
isn't available if the
* MLModel
is in the PENDING
state.
* MLModel
as INPROGRESS
. StartedAt
* isn't available if the MLModel
is in the
* PENDING
state.
* MLModel
as INPROGRESS
.
* StartedAt
isn't available if the
* MLModel
is in the PENDING
state.
* MLModel
. The
* Recipe
provides detailed information about the observation
* data to use during training, and manipulations to perform on the
* observation data during training.
*
* Length: - 131071
*
* @return MLModel
. The
* Recipe
provides detailed information about the
* observation data to use during training, and manipulations to
* perform on the observation data during training.
* MLModel
. The
* Recipe
provides detailed information about the observation
* data to use during training, and manipulations to perform on the
* observation data during training.
*
* Length: - 131071
*
* @param recipe MLModel
. The
* Recipe
provides detailed information about the
* observation data to use during training, and manipulations to
* perform on the observation data during training.
* MLModel
. The
* Recipe
provides detailed information about the observation
* data to use during training, and manipulations to perform on the
* observation data during training.
*
* Length: - 131071
*
* @param recipe MLModel
. The
* Recipe
provides detailed information about the
* observation data to use during training, and manipulations to
* perform on the observation data during training.
* DataSource
.
*
* Length: - 131071
*
* @return DataSource
.
* DataSource
.
*
* Length: - 131071
*
* @param schema DataSource
.
* DataSource
.
*
* Length: - 131071
*
* @param schema DataSource
.
*