#[non_exhaustive]pub struct HyperParameterTrainingJobSummaryBuilder { /* private fields */ }
Expand description
A builder for HyperParameterTrainingJobSummary
.
Implementations§
Source§impl HyperParameterTrainingJobSummaryBuilder
impl HyperParameterTrainingJobSummaryBuilder
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 get_training_job_definition_name(&self) -> &Option<String>
pub fn get_training_job_definition_name(&self) -> &Option<String>
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.
This field is required.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 get_training_job_name(&self) -> &Option<String>
pub fn get_training_job_name(&self) -> &Option<String>
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.
This field is required.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 get_training_job_arn(&self) -> &Option<String>
pub fn get_training_job_arn(&self) -> &Option<String>
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 get_tuning_job_name(&self) -> &Option<String>
pub fn get_tuning_job_name(&self) -> &Option<String>
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.
This field is required.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 get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
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 get_training_start_time(&self) -> &Option<DateTime>
pub fn get_training_start_time(&self) -> &Option<DateTime>
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 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 SageMaker detects a job failure.
Sourcepub fn get_training_end_time(&self) -> &Option<DateTime>
pub fn get_training_end_time(&self) -> &Option<DateTime>
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 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.
This field is required.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 get_training_job_status(&self) -> &Option<TrainingJobStatus>
pub fn get_training_job_status(&self) -> &Option<TrainingJobStatus>
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 get_tuned_hyper_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_tuned_hyper_parameters(&self) -> &Option<HashMap<String, String>>
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 get_failure_reason(&self) -> &Option<String>
pub fn get_failure_reason(&self) -> &Option<String>
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 get_final_hyper_parameter_tuning_job_objective_metric(
&self,
) -> &Option<FinalHyperParameterTuningJobObjectiveMetric>
pub fn get_final_hyper_parameter_tuning_job_objective_metric( &self, ) -> &Option<FinalHyperParameterTuningJobObjectiveMetric>
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 get_objective_status(&self) -> &Option<ObjectiveStatus>
pub fn get_objective_status(&self) -> &Option<ObjectiveStatus>
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§
Source§impl Clone for HyperParameterTrainingJobSummaryBuilder
impl Clone for HyperParameterTrainingJobSummaryBuilder
Source§fn clone(&self) -> HyperParameterTrainingJobSummaryBuilder
fn clone(&self) -> HyperParameterTrainingJobSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for HyperParameterTrainingJobSummaryBuilder
impl Default for HyperParameterTrainingJobSummaryBuilder
Source§fn default() -> HyperParameterTrainingJobSummaryBuilder
fn default() -> HyperParameterTrainingJobSummaryBuilder
Source§impl PartialEq for HyperParameterTrainingJobSummaryBuilder
impl PartialEq for HyperParameterTrainingJobSummaryBuilder
Source§fn eq(&self, other: &HyperParameterTrainingJobSummaryBuilder) -> bool
fn eq(&self, other: &HyperParameterTrainingJobSummaryBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for HyperParameterTrainingJobSummaryBuilder
Auto Trait Implementations§
impl Freeze for HyperParameterTrainingJobSummaryBuilder
impl RefUnwindSafe for HyperParameterTrainingJobSummaryBuilder
impl Send for HyperParameterTrainingJobSummaryBuilder
impl Sync for HyperParameterTrainingJobSummaryBuilder
impl Unpin for HyperParameterTrainingJobSummaryBuilder
impl UnwindSafe for HyperParameterTrainingJobSummaryBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);