| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.SageMaker.CreateTrainingJob
Description
Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a deep learning service other than Amazon SageMaker, provided that you know how to use them for inferences.
In the request body, you provide the following:
AlgorithmSpecification- Identifies the training algorithm to use.HyperParameters- Specify these algorithm-specific parameters to influence the quality of the final model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms .InputDataConfig- Describes the training dataset and the Amazon S3 location where it is stored.OutputDataConfig- Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.ResourceConfig- Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.RoleARN- The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.StoppingCondition- Sets a duration for training. Use this parameter to cap model training costs.
For more information about Amazon SageMaker, see How It Works .
Synopsis
- createTrainingJob :: Text -> AlgorithmSpecification -> Text -> NonEmpty Channel -> OutputDataConfig -> ResourceConfig -> StoppingCondition -> CreateTrainingJob
- data CreateTrainingJob
- ctjHyperParameters :: Lens' CreateTrainingJob (HashMap Text Text)
- ctjVPCConfig :: Lens' CreateTrainingJob (Maybe VPCConfig)
- ctjTags :: Lens' CreateTrainingJob [Tag]
- ctjTrainingJobName :: Lens' CreateTrainingJob Text
- ctjAlgorithmSpecification :: Lens' CreateTrainingJob AlgorithmSpecification
- ctjRoleARN :: Lens' CreateTrainingJob Text
- ctjInputDataConfig :: Lens' CreateTrainingJob (NonEmpty Channel)
- ctjOutputDataConfig :: Lens' CreateTrainingJob OutputDataConfig
- ctjResourceConfig :: Lens' CreateTrainingJob ResourceConfig
- ctjStoppingCondition :: Lens' CreateTrainingJob StoppingCondition
- createTrainingJobResponse :: Int -> Text -> CreateTrainingJobResponse
- data CreateTrainingJobResponse
- ctjrsResponseStatus :: Lens' CreateTrainingJobResponse Int
- ctjrsTrainingJobARN :: Lens' CreateTrainingJobResponse Text
Creating a Request
Arguments
| :: Text | |
| -> AlgorithmSpecification | |
| -> Text | |
| -> NonEmpty Channel | |
| -> OutputDataConfig | |
| -> ResourceConfig | |
| -> StoppingCondition | |
| -> CreateTrainingJob |
Creates a value of CreateTrainingJob with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctjHyperParameters- Algorithm-specific parameters. You set hyperparameters before you start the learning process. Hyperparameters influence the quality of the model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms . You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by theLength Constraint.ctjVPCConfig- A object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see 'train-vpc'ctjTags- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .ctjTrainingJobName- The name of the training job. The name must be unique within an AWS Region in an AWS account. It appears in the Amazon SageMaker console.ctjAlgorithmSpecification- The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms . For information about providing your own algorithms, see 'your-algorithms' .ctjRoleARN- The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles .ctjInputDataConfig- An array ofChannelobjects. Each channel is a named input source.InputDataConfigdescribes the input data and its location. Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data,training_dataandvalidation_data. The configuration for each channel provides the S3 location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams.ctjOutputDataConfig- Specifies the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.ctjResourceConfig- The resources, including the ML compute instances and ML storage volumes, to use for model training. ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, chooseFileas theTrainingInputModein the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.ctjStoppingCondition- Sets a duration for training. Use this parameter to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm theSIGTERMsignal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts. When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job. This intermediate data is a valid model artifact. You can use it to create a model using theCreateModelAPI.
data CreateTrainingJob Source #
See: createTrainingJob smart constructor.
Instances
Request Lenses
ctjHyperParameters :: Lens' CreateTrainingJob (HashMap Text Text) Source #
Algorithm-specific parameters. You set hyperparameters before you start the learning process. Hyperparameters influence the quality of the model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms . You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint .
ctjVPCConfig :: Lens' CreateTrainingJob (Maybe VPCConfig) Source #
A object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see 'train-vpc'
ctjTags :: Lens' CreateTrainingJob [Tag] Source #
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
ctjTrainingJobName :: Lens' CreateTrainingJob Text Source #
The name of the training job. The name must be unique within an AWS Region in an AWS account. It appears in the Amazon SageMaker console.
ctjAlgorithmSpecification :: Lens' CreateTrainingJob AlgorithmSpecification Source #
The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms . For information about providing your own algorithms, see 'your-algorithms' .
ctjRoleARN :: Lens' CreateTrainingJob Text Source #
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles .
ctjInputDataConfig :: Lens' CreateTrainingJob (NonEmpty Channel) Source #
An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location. Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data . The configuration for each channel provides the S3 location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams.
ctjOutputDataConfig :: Lens' CreateTrainingJob OutputDataConfig Source #
Specifies the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
ctjResourceConfig :: Lens' CreateTrainingJob ResourceConfig Source #
The resources, including the ML compute instances and ML storage volumes, to use for model training. ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
ctjStoppingCondition :: Lens' CreateTrainingJob StoppingCondition Source #
Sets a duration for training. Use this parameter to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts. When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job. This intermediate data is a valid model artifact. You can use it to create a model using the CreateModel API.
Destructuring the Response
createTrainingJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateTrainingJobResponse |
Creates a value of CreateTrainingJobResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctjrsResponseStatus- -- | The response status code.ctjrsTrainingJobARN- The Amazon Resource Name (ARN) of the training job.
data CreateTrainingJobResponse Source #
See: createTrainingJobResponse smart constructor.
Instances
Response Lenses
ctjrsResponseStatus :: Lens' CreateTrainingJobResponse Int Source #
- - | The response status code.
ctjrsTrainingJobARN :: Lens' CreateTrainingJobResponse Text Source #
The Amazon Resource Name (ARN) of the training job.