public class CreateMLModelRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateMLModel operation
.
Creates a new MLModel
using the data files and the recipe
as information sources.
An MLModel
is nearly immutable. Users can only update the
MLModelName
and the ScoreThreshold
in an
MLModel
without creating a new MLModel
.
CreateMLModel
is an asynchronous operation. In response
to CreateMLModel
, Amazon Machine Learning (Amazon ML)
immediately returns and sets the MLModel
status to
PENDING
. After the MLModel
is created and
ready for use, Amazon ML sets the status to COMPLETED
.
You can use the GetMLModel operation to check progress of the
MLModel
during the creation operation.
CreateMLModel requires a DataSource
with computed
statistics, which can be created by setting
ComputeStatistics
to true
in
CreateDataSourceFromRDS, CreateDataSourceFromS3, or
CreateDataSourceFromRedshift operations.
NOOP
Constructor and Description |
---|
CreateMLModelRequest() |
Modifier and Type | Method and Description |
---|---|
CreateMLModelRequest |
addParametersEntry(String key,
String value)
A list of the training parameters in the
MLModel . |
CreateMLModelRequest |
clearParametersEntries()
Removes all the entries added into Parameters.
|
CreateMLModelRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getMLModelId()
A user-supplied ID that uniquely identifies the
MLModel . |
String |
getMLModelName()
A user-supplied name or description of the
MLModel . |
String |
getMLModelType()
The category of supervised learning that this
MLModel
will address. |
Map<String,String> |
getParameters()
A list of the training parameters in the
MLModel . |
String |
getRecipe()
The data recipe for creating
MLModel . |
String |
getRecipeUri()
The Amazon Simple Storage Service (Amazon S3) location and file name
that contains the
MLModel recipe. |
String |
getTrainingDataSourceId()
The
DataSource that points to the training data. |
int |
hashCode() |
void |
setMLModelId(String mLModelId)
A user-supplied ID that uniquely identifies the
MLModel . |
void |
setMLModelName(String mLModelName)
A user-supplied name or description of the
MLModel . |
void |
setMLModelType(MLModelType mLModelType)
The category of supervised learning that this
MLModel
will address. |
void |
setMLModelType(String mLModelType)
The category of supervised learning that this
MLModel
will address. |
void |
setParameters(Map<String,String> parameters)
A list of the training parameters in the
MLModel . |
void |
setRecipe(String recipe)
The data recipe for creating
MLModel . |
void |
setRecipeUri(String recipeUri)
The Amazon Simple Storage Service (Amazon S3) location and file name
that contains the
MLModel recipe. |
void |
setTrainingDataSourceId(String trainingDataSourceId)
The
DataSource that points to the training data. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateMLModelRequest |
withMLModelId(String mLModelId)
A user-supplied ID that uniquely identifies the
MLModel . |
CreateMLModelRequest |
withMLModelName(String mLModelName)
A user-supplied name or description of the
MLModel . |
CreateMLModelRequest |
withMLModelType(MLModelType mLModelType)
The category of supervised learning that this
MLModel
will address. |
CreateMLModelRequest |
withMLModelType(String mLModelType)
The category of supervised learning that this
MLModel
will address. |
CreateMLModelRequest |
withParameters(Map<String,String> parameters)
A list of the training parameters in the
MLModel . |
CreateMLModelRequest |
withRecipe(String recipe)
The data recipe for creating
MLModel . |
CreateMLModelRequest |
withRecipeUri(String recipeUri)
The Amazon Simple Storage Service (Amazon S3) location and file name
that contains the
MLModel recipe. |
CreateMLModelRequest |
withTrainingDataSourceId(String trainingDataSourceId)
The
DataSource that points to the training data. |
copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getMLModelId()
MLModel
.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
MLModel
.public void setMLModelId(String mLModelId)
MLModel
.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
mLModelId
- A user-supplied ID that uniquely identifies the MLModel
.public CreateMLModelRequest withMLModelId(String mLModelId)
MLModel
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
mLModelId
- A user-supplied ID that uniquely identifies the MLModel
.public String getMLModelName()
MLModel
.
Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$
MLModel
.public void setMLModelName(String mLModelName)
MLModel
.
Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$
mLModelName
- A user-supplied name or description of the MLModel
.public CreateMLModelRequest withMLModelName(String mLModelName)
MLModel
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$
mLModelName
- A user-supplied name or description of the MLModel
.public String getMLModelType()
MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS
MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
MLModelType
public void setMLModelType(String mLModelType)
MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS
mLModelType
- The category of supervised learning that this MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
MLModelType
public CreateMLModelRequest withMLModelType(String mLModelType)
MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS
mLModelType
- The category of supervised learning that this MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
MLModelType
public void setMLModelType(MLModelType mLModelType)
MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS
mLModelType
- The category of supervised learning that this MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
MLModelType
public CreateMLModelRequest withMLModelType(MLModelType mLModelType)
MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS
mLModelType
- The category of supervised learning that this MLModel
will address. Choose from the following types: REGRESSION
if the MLModel
will be used to
predict a numeric value.BINARY
if the
MLModel
result has two possible values.MULTICLASS
if the MLModel
result has a
limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
MLModelType
public Map<String,String> getParameters()
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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
public void setParameters(Map<String,String> parameters)
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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
parameters
- 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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
public CreateMLModelRequest withParameters(Map<String,String> parameters)
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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
Returns a reference to this object so that method calls can be chained together.
parameters
- 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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
public CreateMLModelRequest addParametersEntry(String key, String value)
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 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 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, start by specifying a small value
such as 1.0E-08.
The valuseis a double that ranges from 0 to
MAX_DOUBLE. The default is not to use L2 normalization. This cannot be
used when L1
is specified. Use this parameter
sparingly.
sgd.maxPasses
- 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
- 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.
The method adds a new key-value pair into Parameters parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Parameters.value
- The corresponding value of the entry to be added into Parameters.public CreateMLModelRequest clearParametersEntries()
Returns a reference to this object so that method calls can be chained together.
public String getTrainingDataSourceId()
DataSource
that points to the training data.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
DataSource
that points to the training data.public void setTrainingDataSourceId(String trainingDataSourceId)
DataSource
that points to the training data.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
trainingDataSourceId
- The DataSource
that points to the training data.public CreateMLModelRequest withTrainingDataSourceId(String trainingDataSourceId)
DataSource
that points to the training data.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
trainingDataSourceId
- The DataSource
that points to the training data.public String getRecipe()
MLModel
. You must specify
either the recipe or its URI. If you don???t specify a recipe or its
URI, Amazon ML creates a default.
Constraints:
Length: 0 - 131071
MLModel
. You must specify
either the recipe or its URI. If you don???t specify a recipe or its
URI, Amazon ML creates a default.public void setRecipe(String recipe)
MLModel
. You must specify
either the recipe or its URI. If you don???t specify a recipe or its
URI, Amazon ML creates a default.
Constraints:
Length: 0 - 131071
recipe
- The data recipe for creating MLModel
. You must specify
either the recipe or its URI. If you don???t specify a recipe or its
URI, Amazon ML creates a default.public CreateMLModelRequest withRecipe(String recipe)
MLModel
. You must specify
either the recipe or its URI. If you don???t specify a recipe or its
URI, Amazon ML creates a default.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 131071
recipe
- The data recipe for creating MLModel
. You must specify
either the recipe or its URI. If you don???t specify a recipe or its
URI, Amazon ML creates a default.public String getRecipeUri()
MLModel
recipe. You must specify either
the recipe or its URI. If you don???t specify a recipe or its URI,
Amazon ML creates a default.
Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?
MLModel
recipe. You must specify either
the recipe or its URI. If you don???t specify a recipe or its URI,
Amazon ML creates a default.public void setRecipeUri(String recipeUri)
MLModel
recipe. You must specify either
the recipe or its URI. If you don???t specify a recipe or its URI,
Amazon ML creates a default.
Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?
recipeUri
- The Amazon Simple Storage Service (Amazon S3) location and file name
that contains the MLModel
recipe. You must specify either
the recipe or its URI. If you don???t specify a recipe or its URI,
Amazon ML creates a default.public CreateMLModelRequest withRecipeUri(String recipeUri)
MLModel
recipe. You must specify either
the recipe or its URI. If you don???t specify a recipe or its URI,
Amazon ML creates a default.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?
recipeUri
- The Amazon Simple Storage Service (Amazon S3) location and file name
that contains the MLModel
recipe. You must specify either
the recipe or its URI. If you don???t specify a recipe or its URI,
Amazon ML creates a default.public String toString()
toString
in class Object
Object.toString()
public CreateMLModelRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.