#[non_exhaustive]pub struct HyperParameterTuningJobSearchEntityBuilder { /* private fields */ }
Expand description
A builder for HyperParameterTuningJobSearchEntity
.
Implementations§
Source§impl HyperParameterTuningJobSearchEntityBuilder
impl HyperParameterTuningJobSearchEntityBuilder
Sourcepub fn hyper_parameter_tuning_job_name(self, input: impl Into<String>) -> Self
pub fn hyper_parameter_tuning_job_name(self, input: impl Into<String>) -> Self
The name of a hyperparameter tuning job.
Sourcepub fn set_hyper_parameter_tuning_job_name(self, input: Option<String>) -> Self
pub fn set_hyper_parameter_tuning_job_name(self, input: Option<String>) -> Self
The name of a hyperparameter tuning job.
Sourcepub fn get_hyper_parameter_tuning_job_name(&self) -> &Option<String>
pub fn get_hyper_parameter_tuning_job_name(&self) -> &Option<String>
The name of a hyperparameter tuning job.
Sourcepub fn hyper_parameter_tuning_job_arn(self, input: impl Into<String>) -> Self
pub fn hyper_parameter_tuning_job_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of a hyperparameter tuning job.
Sourcepub fn set_hyper_parameter_tuning_job_arn(self, input: Option<String>) -> Self
pub fn set_hyper_parameter_tuning_job_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of a hyperparameter tuning job.
Sourcepub fn get_hyper_parameter_tuning_job_arn(&self) -> &Option<String>
pub fn get_hyper_parameter_tuning_job_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of a hyperparameter tuning job.
Sourcepub fn hyper_parameter_tuning_job_config(
self,
input: HyperParameterTuningJobConfig,
) -> Self
pub fn hyper_parameter_tuning_job_config( self, input: HyperParameterTuningJobConfig, ) -> Self
Configures a hyperparameter tuning job.
Sourcepub fn set_hyper_parameter_tuning_job_config(
self,
input: Option<HyperParameterTuningJobConfig>,
) -> Self
pub fn set_hyper_parameter_tuning_job_config( self, input: Option<HyperParameterTuningJobConfig>, ) -> Self
Configures a hyperparameter tuning job.
Sourcepub fn get_hyper_parameter_tuning_job_config(
&self,
) -> &Option<HyperParameterTuningJobConfig>
pub fn get_hyper_parameter_tuning_job_config( &self, ) -> &Option<HyperParameterTuningJobConfig>
Configures a hyperparameter tuning job.
Sourcepub fn training_job_definition(
self,
input: HyperParameterTrainingJobDefinition,
) -> Self
pub fn training_job_definition( self, input: HyperParameterTrainingJobDefinition, ) -> Self
Defines the training jobs launched by a hyperparameter tuning job.
Sourcepub fn set_training_job_definition(
self,
input: Option<HyperParameterTrainingJobDefinition>,
) -> Self
pub fn set_training_job_definition( self, input: Option<HyperParameterTrainingJobDefinition>, ) -> Self
Defines the training jobs launched by a hyperparameter tuning job.
Sourcepub fn get_training_job_definition(
&self,
) -> &Option<HyperParameterTrainingJobDefinition>
pub fn get_training_job_definition( &self, ) -> &Option<HyperParameterTrainingJobDefinition>
Defines the training jobs launched by a hyperparameter tuning job.
Sourcepub fn training_job_definitions(
self,
input: HyperParameterTrainingJobDefinition,
) -> Self
pub fn training_job_definitions( self, input: HyperParameterTrainingJobDefinition, ) -> Self
Appends an item to training_job_definitions
.
To override the contents of this collection use set_training_job_definitions
.
The job definitions included in a hyperparameter tuning job.
Sourcepub fn set_training_job_definitions(
self,
input: Option<Vec<HyperParameterTrainingJobDefinition>>,
) -> Self
pub fn set_training_job_definitions( self, input: Option<Vec<HyperParameterTrainingJobDefinition>>, ) -> Self
The job definitions included in a hyperparameter tuning job.
Sourcepub fn get_training_job_definitions(
&self,
) -> &Option<Vec<HyperParameterTrainingJobDefinition>>
pub fn get_training_job_definitions( &self, ) -> &Option<Vec<HyperParameterTrainingJobDefinition>>
The job definitions included in a hyperparameter tuning job.
Sourcepub fn hyper_parameter_tuning_job_status(
self,
input: HyperParameterTuningJobStatus,
) -> Self
pub fn hyper_parameter_tuning_job_status( self, input: HyperParameterTuningJobStatus, ) -> Self
The status of a hyperparameter tuning job.
Sourcepub fn set_hyper_parameter_tuning_job_status(
self,
input: Option<HyperParameterTuningJobStatus>,
) -> Self
pub fn set_hyper_parameter_tuning_job_status( self, input: Option<HyperParameterTuningJobStatus>, ) -> Self
The status of a hyperparameter tuning job.
Sourcepub fn get_hyper_parameter_tuning_job_status(
&self,
) -> &Option<HyperParameterTuningJobStatus>
pub fn get_hyper_parameter_tuning_job_status( &self, ) -> &Option<HyperParameterTuningJobStatus>
The status of a hyperparameter tuning job.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The time that a hyperparameter tuning job was created.
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The time that a hyperparameter tuning job was created.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
The time that a hyperparameter tuning job was created.
Sourcepub fn hyper_parameter_tuning_end_time(self, input: DateTime) -> Self
pub fn hyper_parameter_tuning_end_time(self, input: DateTime) -> Self
The time that a hyperparameter tuning job ended.
Sourcepub fn set_hyper_parameter_tuning_end_time(
self,
input: Option<DateTime>,
) -> Self
pub fn set_hyper_parameter_tuning_end_time( self, input: Option<DateTime>, ) -> Self
The time that a hyperparameter tuning job ended.
Sourcepub fn get_hyper_parameter_tuning_end_time(&self) -> &Option<DateTime>
pub fn get_hyper_parameter_tuning_end_time(&self) -> &Option<DateTime>
The time that a hyperparameter tuning job ended.
Sourcepub fn last_modified_time(self, input: DateTime) -> Self
pub fn last_modified_time(self, input: DateTime) -> Self
The time that a hyperparameter tuning job was last modified.
Sourcepub fn set_last_modified_time(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self
The time that a hyperparameter tuning job was last modified.
Sourcepub fn get_last_modified_time(&self) -> &Option<DateTime>
pub fn get_last_modified_time(&self) -> &Option<DateTime>
The time that a hyperparameter tuning job was last modified.
Sourcepub fn training_job_status_counters(
self,
input: TrainingJobStatusCounters,
) -> Self
pub fn training_job_status_counters( self, input: TrainingJobStatusCounters, ) -> Self
The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
Sourcepub fn set_training_job_status_counters(
self,
input: Option<TrainingJobStatusCounters>,
) -> Self
pub fn set_training_job_status_counters( self, input: Option<TrainingJobStatusCounters>, ) -> Self
The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
Sourcepub fn get_training_job_status_counters(
&self,
) -> &Option<TrainingJobStatusCounters>
pub fn get_training_job_status_counters( &self, ) -> &Option<TrainingJobStatusCounters>
The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
Sourcepub fn objective_status_counters(self, input: ObjectiveStatusCounters) -> Self
pub fn objective_status_counters(self, input: ObjectiveStatusCounters) -> Self
Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
Sourcepub fn set_objective_status_counters(
self,
input: Option<ObjectiveStatusCounters>,
) -> Self
pub fn set_objective_status_counters( self, input: Option<ObjectiveStatusCounters>, ) -> Self
Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
Sourcepub fn get_objective_status_counters(&self) -> &Option<ObjectiveStatusCounters>
pub fn get_objective_status_counters(&self) -> &Option<ObjectiveStatusCounters>
Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
Sourcepub fn best_training_job(self, input: HyperParameterTrainingJobSummary) -> Self
pub fn best_training_job(self, input: HyperParameterTrainingJobSummary) -> Self
The container for the summary information about a training job.
Sourcepub fn set_best_training_job(
self,
input: Option<HyperParameterTrainingJobSummary>,
) -> Self
pub fn set_best_training_job( self, input: Option<HyperParameterTrainingJobSummary>, ) -> Self
The container for the summary information about a training job.
Sourcepub fn get_best_training_job(&self) -> &Option<HyperParameterTrainingJobSummary>
pub fn get_best_training_job(&self) -> &Option<HyperParameterTrainingJobSummary>
The container for the summary information about a training job.
Sourcepub fn overall_best_training_job(
self,
input: HyperParameterTrainingJobSummary,
) -> Self
pub fn overall_best_training_job( self, input: HyperParameterTrainingJobSummary, ) -> Self
The container for the summary information about a training job.
Sourcepub fn set_overall_best_training_job(
self,
input: Option<HyperParameterTrainingJobSummary>,
) -> Self
pub fn set_overall_best_training_job( self, input: Option<HyperParameterTrainingJobSummary>, ) -> Self
The container for the summary information about a training job.
Sourcepub fn get_overall_best_training_job(
&self,
) -> &Option<HyperParameterTrainingJobSummary>
pub fn get_overall_best_training_job( &self, ) -> &Option<HyperParameterTrainingJobSummary>
The container for the summary information about a training job.
Sourcepub fn warm_start_config(
self,
input: HyperParameterTuningJobWarmStartConfig,
) -> Self
pub fn warm_start_config( self, input: HyperParameterTuningJobWarmStartConfig, ) -> Self
Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
Sourcepub fn set_warm_start_config(
self,
input: Option<HyperParameterTuningJobWarmStartConfig>,
) -> Self
pub fn set_warm_start_config( self, input: Option<HyperParameterTuningJobWarmStartConfig>, ) -> Self
Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
Sourcepub fn get_warm_start_config(
&self,
) -> &Option<HyperParameterTuningJobWarmStartConfig>
pub fn get_warm_start_config( &self, ) -> &Option<HyperParameterTuningJobWarmStartConfig>
Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
Sourcepub fn failure_reason(self, input: impl Into<String>) -> Self
pub fn failure_reason(self, input: impl Into<String>) -> Self
The error that was created when a hyperparameter tuning job failed.
Sourcepub fn set_failure_reason(self, input: Option<String>) -> Self
pub fn set_failure_reason(self, input: Option<String>) -> Self
The error that was created when a hyperparameter tuning job failed.
Sourcepub fn get_failure_reason(&self) -> &Option<String>
pub fn get_failure_reason(&self) -> &Option<String>
The error that was created when a hyperparameter tuning job failed.
Sourcepub fn tuning_job_completion_details(
self,
input: HyperParameterTuningJobCompletionDetails,
) -> Self
pub fn tuning_job_completion_details( self, input: HyperParameterTuningJobCompletionDetails, ) -> Self
Information about either a current or completed hyperparameter tuning job.
Sourcepub fn set_tuning_job_completion_details(
self,
input: Option<HyperParameterTuningJobCompletionDetails>,
) -> Self
pub fn set_tuning_job_completion_details( self, input: Option<HyperParameterTuningJobCompletionDetails>, ) -> Self
Information about either a current or completed hyperparameter tuning job.
Sourcepub fn get_tuning_job_completion_details(
&self,
) -> &Option<HyperParameterTuningJobCompletionDetails>
pub fn get_tuning_job_completion_details( &self, ) -> &Option<HyperParameterTuningJobCompletionDetails>
Information about either a current or completed hyperparameter tuning job.
Sourcepub fn consumed_resources(
self,
input: HyperParameterTuningJobConsumedResources,
) -> Self
pub fn consumed_resources( self, input: HyperParameterTuningJobConsumedResources, ) -> Self
The total amount of resources consumed by a hyperparameter tuning job.
Sourcepub fn set_consumed_resources(
self,
input: Option<HyperParameterTuningJobConsumedResources>,
) -> Self
pub fn set_consumed_resources( self, input: Option<HyperParameterTuningJobConsumedResources>, ) -> Self
The total amount of resources consumed by a hyperparameter tuning job.
Sourcepub fn get_consumed_resources(
&self,
) -> &Option<HyperParameterTuningJobConsumedResources>
pub fn get_consumed_resources( &self, ) -> &Option<HyperParameterTuningJobConsumedResources>
The total amount of resources consumed by a hyperparameter tuning job.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
Sourcepub fn build(self) -> HyperParameterTuningJobSearchEntity
pub fn build(self) -> HyperParameterTuningJobSearchEntity
Consumes the builder and constructs a HyperParameterTuningJobSearchEntity
.
Trait Implementations§
Source§impl Clone for HyperParameterTuningJobSearchEntityBuilder
impl Clone for HyperParameterTuningJobSearchEntityBuilder
Source§fn clone(&self) -> HyperParameterTuningJobSearchEntityBuilder
fn clone(&self) -> HyperParameterTuningJobSearchEntityBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for HyperParameterTuningJobSearchEntityBuilder
impl Default for HyperParameterTuningJobSearchEntityBuilder
Source§fn default() -> HyperParameterTuningJobSearchEntityBuilder
fn default() -> HyperParameterTuningJobSearchEntityBuilder
Source§impl PartialEq for HyperParameterTuningJobSearchEntityBuilder
impl PartialEq for HyperParameterTuningJobSearchEntityBuilder
Source§fn eq(&self, other: &HyperParameterTuningJobSearchEntityBuilder) -> bool
fn eq(&self, other: &HyperParameterTuningJobSearchEntityBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for HyperParameterTuningJobSearchEntityBuilder
Auto Trait Implementations§
impl Freeze for HyperParameterTuningJobSearchEntityBuilder
impl RefUnwindSafe for HyperParameterTuningJobSearchEntityBuilder
impl Send for HyperParameterTuningJobSearchEntityBuilder
impl Sync for HyperParameterTuningJobSearchEntityBuilder
impl Unpin for HyperParameterTuningJobSearchEntityBuilder
impl UnwindSafe for HyperParameterTuningJobSearchEntityBuilder
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);