TrainingJob

public struct TrainingJob : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • Information about the algorithm used for training, and algorithm metadata.

    Declaration

    Swift

    public let algorithmSpecification: AlgorithmSpecification?
  • The Amazon Resource Name (ARN) of the job.

    Declaration

    Swift

    public let autoMLJobArn: String?
  • The billable time in seconds.

    Declaration

    Swift

    public let billableTimeInSeconds: Int?
  • Undocumented

    Declaration

    Swift

    public let checkpointConfig: CheckpointConfig?
  • A timestamp that indicates when the training job was created.

    Declaration

    Swift

    public let creationTime: TimeStamp?
  • Undocumented

    Declaration

    Swift

    public let debugHookConfig: DebugHookConfig?
  • Information about the debug rule configuration.

    Declaration

    Swift

    public let debugRuleConfigurations: [DebugRuleConfiguration]?
  • Information about the evaluation status of the rules for the training job.

    Declaration

    Swift

    public let debugRuleEvaluationStatuses: [DebugRuleEvaluationStatus]?
  • To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

    Declaration

    Swift

    public let enableInterContainerTrafficEncryption: Bool?
  • When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

    Declaration

    Swift

    public let enableManagedSpotTraining: Bool?
  • If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can’t communicate beyond the VPC they run in.

    Declaration

    Swift

    public let enableNetworkIsolation: Bool?
  • Undocumented

    Declaration

    Swift

    public let experimentConfig: ExperimentConfig?
  • If the training job failed, the reason it failed.

    Declaration

    Swift

    public let failureReason: String?
  • A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

    Declaration

    Swift

    public let finalMetricDataList: [MetricData]?
  • Algorithm-specific parameters.

    Declaration

    Swift

    public let hyperParameters: [String : String]?
  • An array of Channel objects that describes each data input channel.

    Declaration

    Swift

    public let inputDataConfig: [Channel]?
  • The Amazon Resource Name (ARN) of the labeling job.

    Declaration

    Swift

    public let labelingJobArn: String?
  • A timestamp that indicates when the status of the training job was last modified.

    Declaration

    Swift

    public let lastModifiedTime: TimeStamp?
  • Information about the Amazon S3 location that is configured for storing model artifacts.

    Declaration

    Swift

    public let modelArtifacts: ModelArtifacts?
  • The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

    Declaration

    Swift

    public let outputDataConfig: OutputDataConfig?
  • Resources, including ML compute instances and ML storage volumes, that are configured for model training.

    Declaration

    Swift

    public let resourceConfig: ResourceConfig?
  • The AWS Identity and Access Management (IAM) role configured for the training job.

    Declaration

    Swift

    public let roleArn: String?
  • Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage

    Declaration

    Swift

    public let secondaryStatus: SecondaryStatus?
  • A history of all of the secondary statuses that the training job has transitioned through.

    Declaration

    Swift

    public let secondaryStatusTransitions: [SecondaryStatusTransition]?
  • Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API 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 can use this 120-second window to save the model artifacts, so the results of training are not lost.

    Declaration

    Swift

    public let stoppingCondition: StoppingCondition?
  • An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    Declaration

    Swift

    public let tags: [Tag]?
  • Undocumented

    Declaration

    Swift

    public let tensorBoardOutputConfig: TensorBoardOutputConfig?
  • Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    Declaration

    Swift

    public let trainingEndTime: TimeStamp?
  • The Amazon Resource Name (ARN) of the training job.

    Declaration

    Swift

    public let trainingJobArn: String?
  • The name of the training job.

    Declaration

    Swift

    public let trainingJobName: String?
  • The status of the training job. Training job statuses are: InProgress - The training is in progress. Completed - The training job has completed. Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call. Stopping - The training job is stopping. Stopped - The training job has stopped. For more detailed information, see SecondaryStatus.

    Declaration

    Swift

    public let trainingJobStatus: TrainingJobStatus?
  • Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

    Declaration

    Swift

    public let trainingStartTime: TimeStamp?
  • The training time in seconds.

    Declaration

    Swift

    public let trainingTimeInSeconds: Int?
  • The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

    Declaration

    Swift

    public let tuningJobArn: String?
  • A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

    Declaration

    Swift

    public let vpcConfig: VpcConfig?
  • Undocumented

    Declaration

    Swift

    public init(algorithmSpecification: AlgorithmSpecification? = nil, autoMLJobArn: String? = nil, billableTimeInSeconds: Int? = nil, checkpointConfig: CheckpointConfig? = nil, creationTime: TimeStamp? = nil, debugHookConfig: DebugHookConfig? = nil, debugRuleConfigurations: [DebugRuleConfiguration]? = nil, debugRuleEvaluationStatuses: [DebugRuleEvaluationStatus]? = nil, enableInterContainerTrafficEncryption: Bool? = nil, enableManagedSpotTraining: Bool? = nil, enableNetworkIsolation: Bool? = nil, experimentConfig: ExperimentConfig? = nil, failureReason: String? = nil, finalMetricDataList: [MetricData]? = nil, hyperParameters: [String : String]? = nil, inputDataConfig: [Channel]? = nil, labelingJobArn: String? = nil, lastModifiedTime: TimeStamp? = nil, modelArtifacts: ModelArtifacts? = nil, outputDataConfig: OutputDataConfig? = nil, resourceConfig: ResourceConfig? = nil, roleArn: String? = nil, secondaryStatus: SecondaryStatus? = nil, secondaryStatusTransitions: [SecondaryStatusTransition]? = nil, stoppingCondition: StoppingCondition? = nil, tags: [Tag]? = nil, tensorBoardOutputConfig: TensorBoardOutputConfig? = nil, trainingEndTime: TimeStamp? = nil, trainingJobArn: String? = nil, trainingJobName: String? = nil, trainingJobStatus: TrainingJobStatus? = nil, trainingStartTime: TimeStamp? = nil, trainingTimeInSeconds: Int? = nil, tuningJobArn: String? = nil, vpcConfig: VpcConfig? = nil)