Struct rusoto_sagemaker::TrainingJob

pub struct TrainingJob {

    pub algorithm_specification: Option<AlgorithmSpecification>,
    pub auto_ml_job_arn: Option<String>,
    pub billable_time_in_seconds: Option<i64>,
    pub checkpoint_config: Option<CheckpointConfig>,
    pub creation_time: Option<f64>,
    pub debug_hook_config: Option<DebugHookConfig>,
    pub debug_rule_configurations: Option<Vec<DebugRuleConfiguration>>,
    pub debug_rule_evaluation_statuses: Option<Vec<DebugRuleEvaluationStatus>>,
    pub enable_inter_container_traffic_encryption: Option<bool>,
    pub enable_managed_spot_training: Option<bool>,
    pub enable_network_isolation: Option<bool>,
    pub environment: Option<HashMap<String, String>>,
    pub experiment_config: Option<ExperimentConfig>,
    pub failure_reason: Option<String>,
    pub final_metric_data_list: Option<Vec<MetricData>>,
    pub hyper_parameters: Option<HashMap<String, String>>,
    pub input_data_config: Option<Vec<Channel>>,
    pub labeling_job_arn: Option<String>,
    pub last_modified_time: Option<f64>,
    pub model_artifacts: Option<ModelArtifacts>,
    pub output_data_config: Option<OutputDataConfig>,
    pub resource_config: Option<ResourceConfig>,
    pub retry_strategy: Option<RetryStrategy>,
    pub role_arn: Option<String>,
    pub secondary_status: Option<String>,
    pub secondary_status_transitions: Option<Vec<SecondaryStatusTransition>>,
    pub stopping_condition: Option<StoppingCondition>,
    pub tags: Option<Vec<Tag>>,
    pub tensor_board_output_config: Option<TensorBoardOutputConfig>,
    pub training_end_time: Option<f64>,
    pub training_job_arn: Option<String>,
    pub training_job_name: Option<String>,
    pub training_job_status: Option<String>,
    pub training_start_time: Option<f64>,
    pub training_time_in_seconds: Option<i64>,
    pub tuning_job_arn: Option<String>,
    pub vpc_config: Option<VpcConfig>,
}

Contains information about a training job.

Fields

algorithm_specification: Option<AlgorithmSpecification>

Information about the algorithm used for training, and algorithm metadata.

auto_ml_job_arn: Option<String>

The Amazon Resource Name (ARN) of the job.

billable_time_in_seconds: Option<i64>

The billable time in seconds.

checkpoint_config: Option<CheckpointConfig>

creation_time: Option<f64>

A timestamp that indicates when the training job was created.

debug_hook_config: Option<DebugHookConfig>

debug_rule_configurations: Option<Vec<DebugRuleConfiguration>>

Information about the debug rule configuration.

debug_rule_evaluation_statuses: Option<Vec<DebugRuleEvaluationStatus>>

Information about the evaluation status of the rules for the training job.

enable_inter_container_traffic_encryption: Option<bool>

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.

enable_managed_spot_training: Option<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.

enable_network_isolation: Option<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.

environment: Option<HashMap<String, String>>

The environment variables to set in the Docker container.

experiment_config: Option<ExperimentConfig>

failure_reason: Option<String>

If the training job failed, the reason it failed.

final_metric_data_list: Option<Vec<MetricData>>

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.

hyper_parameters: Option<HashMap<String, String>>

Algorithm-specific parameters.

input_data_config: Option<Vec<Channel>>

An array of Channel objects that describes each data input channel.

labeling_job_arn: Option<String>

The Amazon Resource Name (ARN) of the labeling job.

last_modified_time: Option<f64>

A timestamp that indicates when the status of the training job was last modified.

model_artifacts: Option<ModelArtifacts>

Information about the Amazon S3 location that is configured for storing model artifacts.

output_data_config: Option<OutputDataConfig>

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

resource_config: Option<ResourceConfig>

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

retry_strategy: Option<RetryStrategy>

The number of times to retry the job when the job fails due to an InternalServerError.

role_arn: Option<String>

The AWS Identity and Access Management (IAM) role configured for the training job.

secondary_status: Option<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

secondary_status_transitions: Option<Vec<SecondaryStatusTransition>>

A history of all of the secondary statuses that the training job has transitioned through.

stopping_condition: Option<StoppingCondition>

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. 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.

tags: Option<Vec<Tag>>

An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.

tensor_board_output_config: Option<TensorBoardOutputConfig>

training_end_time: Option<f64>

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.

training_job_arn: Option<String>

The Amazon Resource Name (ARN) of the training job.

training_job_name: Option<String>

The name of the training job.

training_job_status: Option<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.

training_start_time: Option<f64>

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.

training_time_in_seconds: Option<i64>

The training time in seconds.

tuning_job_arn: Option<String>

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

vpc_config: Option<VpcConfig>

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.

Trait Implementations

impl Clone for TrainingJob

fn clone(&self) -> TrainingJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrainingJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TrainingJob

fn default() -> TrainingJob

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrainingJob

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<TrainingJob> for TrainingJob

fn eq(&self, other: &TrainingJob) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TrainingJob) -> bool

This method tests for !=.

impl StructuralPartialEq for TrainingJob