#[non_exhaustive]pub struct Builder { /* private fields */ }
Expand description
A builder for HyperParameterTrainingJobSummary
Implementations
sourceimpl Builder
impl Builder
sourcepub fn training_job_definition_name(self, input: impl Into<String>) -> Self
pub fn training_job_definition_name(self, input: impl Into<String>) -> Self
The training job definition name.
sourcepub fn set_training_job_definition_name(self, input: Option<String>) -> Self
pub fn set_training_job_definition_name(self, input: Option<String>) -> Self
The training job definition name.
sourcepub fn training_job_name(self, input: impl Into<String>) -> Self
pub fn training_job_name(self, input: impl Into<String>) -> Self
The name of the training job.
sourcepub fn set_training_job_name(self, input: Option<String>) -> Self
pub fn set_training_job_name(self, input: Option<String>) -> Self
The name of the training job.
sourcepub fn training_job_arn(self, input: impl Into<String>) -> Self
pub fn training_job_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the training job.
sourcepub fn set_training_job_arn(self, input: Option<String>) -> Self
pub fn set_training_job_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the training job.
sourcepub fn tuning_job_name(self, input: impl Into<String>) -> Self
pub fn tuning_job_name(self, input: impl Into<String>) -> Self
The HyperParameter tuning job that launched the training job.
sourcepub fn set_tuning_job_name(self, input: Option<String>) -> Self
pub fn set_tuning_job_name(self, input: Option<String>) -> Self
The HyperParameter tuning job that launched the training job.
sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The date and time that the training job was created.
sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The date and time that the training job was created.
sourcepub fn training_start_time(self, input: DateTime) -> Self
pub fn training_start_time(self, input: DateTime) -> Self
The date and time that the training job started.
sourcepub fn set_training_start_time(self, input: Option<DateTime>) -> Self
pub fn set_training_start_time(self, input: Option<DateTime>) -> Self
The date and time that the training job started.
sourcepub fn training_end_time(self, input: DateTime) -> Self
pub fn training_end_time(self, input: DateTime) -> Self
Specifies 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.
sourcepub fn set_training_end_time(self, input: Option<DateTime>) -> Self
pub fn set_training_end_time(self, input: Option<DateTime>) -> Self
Specifies 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.
sourcepub fn training_job_status(self, input: TrainingJobStatus) -> Self
pub fn training_job_status(self, input: TrainingJobStatus) -> Self
The status of the training job.
sourcepub fn set_training_job_status(self, input: Option<TrainingJobStatus>) -> Self
pub fn set_training_job_status(self, input: Option<TrainingJobStatus>) -> Self
The status of the training job.
sourcepub fn tuned_hyper_parameters(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
pub fn tuned_hyper_parameters(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
Adds a key-value pair to tuned_hyper_parameters
.
To override the contents of this collection use set_tuned_hyper_parameters
.
A list of the hyperparameters for which you specified ranges to search.
sourcepub fn set_tuned_hyper_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self
pub fn set_tuned_hyper_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self
A list of the hyperparameters for which you specified ranges to search.
sourcepub fn failure_reason(self, input: impl Into<String>) -> Self
pub fn failure_reason(self, input: impl Into<String>) -> Self
The reason that the training job failed.
sourcepub fn set_failure_reason(self, input: Option<String>) -> Self
pub fn set_failure_reason(self, input: Option<String>) -> Self
The reason that the training job failed.
sourcepub fn final_hyper_parameter_tuning_job_objective_metric(
self,
input: FinalHyperParameterTuningJobObjectiveMetric
) -> Self
pub fn final_hyper_parameter_tuning_job_objective_metric(
self,
input: FinalHyperParameterTuningJobObjectiveMetric
) -> Self
The FinalHyperParameterTuningJobObjectiveMetric
object that specifies the value of the objective metric of the tuning job that launched this training job.
sourcepub fn set_final_hyper_parameter_tuning_job_objective_metric(
self,
input: Option<FinalHyperParameterTuningJobObjectiveMetric>
) -> Self
pub fn set_final_hyper_parameter_tuning_job_objective_metric(
self,
input: Option<FinalHyperParameterTuningJobObjectiveMetric>
) -> Self
The FinalHyperParameterTuningJobObjectiveMetric
object that specifies the value of the objective metric of the tuning job that launched this training job.
sourcepub fn objective_status(self, input: ObjectiveStatus) -> Self
pub fn objective_status(self, input: ObjectiveStatus) -> Self
The status of the objective metric for the training job:
-
Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
-
Pending: The training job is in progress and evaluation of its final objective metric is pending.
-
Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
sourcepub fn set_objective_status(self, input: Option<ObjectiveStatus>) -> Self
pub fn set_objective_status(self, input: Option<ObjectiveStatus>) -> Self
The status of the objective metric for the training job:
-
Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
-
Pending: The training job is in progress and evaluation of its final objective metric is pending.
-
Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
sourcepub fn build(self) -> HyperParameterTrainingJobSummary
pub fn build(self) -> HyperParameterTrainingJobSummary
Consumes the builder and constructs a HyperParameterTrainingJobSummary
Trait Implementations
impl StructuralPartialEq for Builder
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more