Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a new version of a model within an an Amazon Lookout for Vision
project. CreateModel
is an asynchronous operation in which Amazon
Lookout for Vision trains, tests, and evaluates a new version of a
model.
To get the current status, check the Status
field returned in the
response from DescribeModel.
If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.
After training completes, the evaluation metrics are stored at the
location specified in OutputConfig
.
This operation requires permissions to perform the
lookoutvision:CreateModel
operation. If you want to tag your model,
you also require permission to the lookoutvision:TagResource
operation.
Synopsis
- data CreateModel = CreateModel' {
- clientToken :: Maybe Text
- description :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe [Tag]
- projectName :: Text
- outputConfig :: OutputConfig
- newCreateModel :: Text -> OutputConfig -> CreateModel
- createModel_clientToken :: Lens' CreateModel (Maybe Text)
- createModel_description :: Lens' CreateModel (Maybe Text)
- createModel_kmsKeyId :: Lens' CreateModel (Maybe Text)
- createModel_tags :: Lens' CreateModel (Maybe [Tag])
- createModel_projectName :: Lens' CreateModel Text
- createModel_outputConfig :: Lens' CreateModel OutputConfig
- data CreateModelResponse = CreateModelResponse' {}
- newCreateModelResponse :: Int -> CreateModelResponse
- createModelResponse_modelMetadata :: Lens' CreateModelResponse (Maybe ModelMetadata)
- createModelResponse_httpStatus :: Lens' CreateModelResponse Int
Creating a Request
data CreateModel Source #
See: newCreateModel
smart constructor.
CreateModel' | |
|
Instances
Create a value of CreateModel
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:clientToken:CreateModel'
, createModel_clientToken
- ClientToken is an idempotency token that ensures a call to CreateModel
completes only once. You choose the value to pass. For example, An issue
might prevent you from getting a response from CreateModel
. In this
case, safely retry your call to CreateModel
by using the same
ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are
using inserts a value for you. This prevents retries after a network
error from starting multiple training jobs. You'll need to provide your
own value for other use cases.
An error occurs if the other input parameters are not the same as in the
first request. Using a different value for ClientToken
is considered a
new call to CreateModel
. An idempotency token is active for 8 hours.
CreateModel
, createModel_description
- A description for the version of the model.
CreateModel
, createModel_kmsKeyId
- The identifier for your AWS KMS key. The key is used to encrypt training
and test images copied into the service for model training. Your source
images are unaffected. If this parameter is not specified, the copied
images are encrypted by a key that AWS owns and manages.
CreateModel
, createModel_tags
- A set of tags (key-value pairs) that you want to attach to the model.
CreateModel
, createModel_projectName
- The name of the project in which you want to create a model version.
CreateModel
, createModel_outputConfig
- The location where Amazon Lookout for Vision saves the training results.
Request Lenses
createModel_clientToken :: Lens' CreateModel (Maybe Text) Source #
ClientToken is an idempotency token that ensures a call to CreateModel
completes only once. You choose the value to pass. For example, An issue
might prevent you from getting a response from CreateModel
. In this
case, safely retry your call to CreateModel
by using the same
ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are
using inserts a value for you. This prevents retries after a network
error from starting multiple training jobs. You'll need to provide your
own value for other use cases.
An error occurs if the other input parameters are not the same as in the
first request. Using a different value for ClientToken
is considered a
new call to CreateModel
. An idempotency token is active for 8 hours.
createModel_description :: Lens' CreateModel (Maybe Text) Source #
A description for the version of the model.
createModel_kmsKeyId :: Lens' CreateModel (Maybe Text) Source #
The identifier for your AWS KMS key. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.
createModel_tags :: Lens' CreateModel (Maybe [Tag]) Source #
A set of tags (key-value pairs) that you want to attach to the model.
createModel_projectName :: Lens' CreateModel Text Source #
The name of the project in which you want to create a model version.
createModel_outputConfig :: Lens' CreateModel OutputConfig Source #
The location where Amazon Lookout for Vision saves the training results.
Destructuring the Response
data CreateModelResponse Source #
See: newCreateModelResponse
smart constructor.
CreateModelResponse' | |
|
Instances
newCreateModelResponse Source #
Create a value of CreateModelResponse
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:modelMetadata:CreateModelResponse'
, createModelResponse_modelMetadata
- The response from a call to CreateModel
.
$sel:httpStatus:CreateModelResponse'
, createModelResponse_httpStatus
- The response's http status code.
Response Lenses
createModelResponse_modelMetadata :: Lens' CreateModelResponse (Maybe ModelMetadata) Source #
The response from a call to CreateModel
.
createModelResponse_httpStatus :: Lens' CreateModelResponse Int Source #
The response's http status code.