#[non_exhaustive]pub struct HyperParameterTuningResourceConfigBuilder { /* private fields */ }Expand description
A builder for HyperParameterTuningResourceConfig.
Implementations§
Source§impl HyperParameterTuningResourceConfigBuilder
impl HyperParameterTuningResourceConfigBuilder
Sourcepub fn instance_type(self, input: TrainingInstanceType) -> Self
pub fn instance_type(self, input: TrainingInstanceType) -> Self
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
Sourcepub fn set_instance_type(self, input: Option<TrainingInstanceType>) -> Self
pub fn set_instance_type(self, input: Option<TrainingInstanceType>) -> Self
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
Sourcepub fn get_instance_type(&self) -> &Option<TrainingInstanceType>
pub fn get_instance_type(&self) -> &Option<TrainingInstanceType>
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
Sourcepub fn instance_count(self, input: i32) -> Self
pub fn instance_count(self, input: i32) -> Self
The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
Sourcepub fn set_instance_count(self, input: Option<i32>) -> Self
pub fn set_instance_count(self, input: Option<i32>) -> Self
The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
Sourcepub fn get_instance_count(&self) -> &Option<i32>
pub fn get_instance_count(&self) -> &Option<i32>
The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
Sourcepub fn volume_size_in_gb(self, input: i32) -> Self
pub fn volume_size_in_gb(self, input: i32) -> Self
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
Sourcepub fn set_volume_size_in_gb(self, input: Option<i32>) -> Self
pub fn set_volume_size_in_gb(self, input: Option<i32>) -> Self
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
Sourcepub fn get_volume_size_in_gb(&self) -> &Option<i32>
pub fn get_volume_size_in_gb(&self) -> &Option<i32>
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
Sourcepub fn volume_kms_key_id(self, input: impl Into<String>) -> Self
pub fn volume_kms_key_id(self, input: impl Into<String>) -> Self
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.
Sourcepub fn set_volume_kms_key_id(self, input: Option<String>) -> Self
pub fn set_volume_kms_key_id(self, input: Option<String>) -> Self
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.
Sourcepub fn get_volume_kms_key_id(&self) -> &Option<String>
pub fn get_volume_kms_key_id(&self) -> &Option<String>
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.
Sourcepub fn allocation_strategy(
self,
input: HyperParameterTuningAllocationStrategy,
) -> Self
pub fn allocation_strategy( self, input: HyperParameterTuningAllocationStrategy, ) -> Self
The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
Sourcepub fn set_allocation_strategy(
self,
input: Option<HyperParameterTuningAllocationStrategy>,
) -> Self
pub fn set_allocation_strategy( self, input: Option<HyperParameterTuningAllocationStrategy>, ) -> Self
The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
Sourcepub fn get_allocation_strategy(
&self,
) -> &Option<HyperParameterTuningAllocationStrategy>
pub fn get_allocation_strategy( &self, ) -> &Option<HyperParameterTuningAllocationStrategy>
The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
Sourcepub fn instance_configs(self, input: HyperParameterTuningInstanceConfig) -> Self
pub fn instance_configs(self, input: HyperParameterTuningInstanceConfig) -> Self
Appends an item to instance_configs.
To override the contents of this collection use set_instance_configs.
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.
Sourcepub fn set_instance_configs(
self,
input: Option<Vec<HyperParameterTuningInstanceConfig>>,
) -> Self
pub fn set_instance_configs( self, input: Option<Vec<HyperParameterTuningInstanceConfig>>, ) -> Self
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.
Sourcepub fn get_instance_configs(
&self,
) -> &Option<Vec<HyperParameterTuningInstanceConfig>>
pub fn get_instance_configs( &self, ) -> &Option<Vec<HyperParameterTuningInstanceConfig>>
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.
Sourcepub fn build(self) -> HyperParameterTuningResourceConfig
pub fn build(self) -> HyperParameterTuningResourceConfig
Consumes the builder and constructs a HyperParameterTuningResourceConfig.
Trait Implementations§
Source§impl Clone for HyperParameterTuningResourceConfigBuilder
impl Clone for HyperParameterTuningResourceConfigBuilder
Source§fn clone(&self) -> HyperParameterTuningResourceConfigBuilder
fn clone(&self) -> HyperParameterTuningResourceConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for HyperParameterTuningResourceConfigBuilder
impl Default for HyperParameterTuningResourceConfigBuilder
Source§fn default() -> HyperParameterTuningResourceConfigBuilder
fn default() -> HyperParameterTuningResourceConfigBuilder
Source§impl PartialEq for HyperParameterTuningResourceConfigBuilder
impl PartialEq for HyperParameterTuningResourceConfigBuilder
Source§fn eq(&self, other: &HyperParameterTuningResourceConfigBuilder) -> bool
fn eq(&self, other: &HyperParameterTuningResourceConfigBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for HyperParameterTuningResourceConfigBuilder
Auto Trait Implementations§
impl Freeze for HyperParameterTuningResourceConfigBuilder
impl RefUnwindSafe for HyperParameterTuningResourceConfigBuilder
impl Send for HyperParameterTuningResourceConfigBuilder
impl Sync for HyperParameterTuningResourceConfigBuilder
impl Unpin for HyperParameterTuningResourceConfigBuilder
impl UnwindSafe for HyperParameterTuningResourceConfigBuilder
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);