pub struct CreateTrialFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateTrial
.
Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
Implementations§
Source§impl CreateTrialFluentBuilder
impl CreateTrialFluentBuilder
Sourcepub fn as_input(&self) -> &CreateTrialInputBuilder
pub fn as_input(&self) -> &CreateTrialInputBuilder
Access the CreateTrial as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateTrialOutput, SdkError<CreateTrialError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateTrialOutput, SdkError<CreateTrialError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateTrialOutput, CreateTrialError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateTrialOutput, CreateTrialError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn trial_name(self, input: impl Into<String>) -> Self
pub fn trial_name(self, input: impl Into<String>) -> Self
The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Sourcepub fn set_trial_name(self, input: Option<String>) -> Self
pub fn set_trial_name(self, input: Option<String>) -> Self
The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Sourcepub fn get_trial_name(&self) -> &Option<String>
pub fn get_trial_name(&self) -> &Option<String>
The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The name of the trial as displayed. The name doesn't need to be unique. If DisplayName
isn't specified, TrialName
is displayed.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The name of the trial as displayed. The name doesn't need to be unique. If DisplayName
isn't specified, TrialName
is displayed.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The name of the trial as displayed. The name doesn't need to be unique. If DisplayName
isn't specified, TrialName
is displayed.
Sourcepub fn experiment_name(self, input: impl Into<String>) -> Self
pub fn experiment_name(self, input: impl Into<String>) -> Self
The name of the experiment to associate the trial with.
Sourcepub fn set_experiment_name(self, input: Option<String>) -> Self
pub fn set_experiment_name(self, input: Option<String>) -> Self
The name of the experiment to associate the trial with.
Sourcepub fn get_experiment_name(&self) -> &Option<String>
pub fn get_experiment_name(&self) -> &Option<String>
The name of the experiment to associate the trial with.
Sourcepub fn metadata_properties(self, input: MetadataProperties) -> Self
pub fn metadata_properties(self, input: MetadataProperties) -> Self
Metadata properties of the tracking entity, trial, or trial component.
Sourcepub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self
pub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self
Metadata properties of the tracking entity, trial, or trial component.
Sourcepub fn get_metadata_properties(&self) -> &Option<MetadataProperties>
pub fn get_metadata_properties(&self) -> &Option<MetadataProperties>
Metadata properties of the tracking entity, trial, or trial component.
A list of tags to associate with the trial. You can use Search API to search on the tags.
A list of tags to associate with the trial. You can use Search API to search on the tags.
Trait Implementations§
Source§impl Clone for CreateTrialFluentBuilder
impl Clone for CreateTrialFluentBuilder
Source§fn clone(&self) -> CreateTrialFluentBuilder
fn clone(&self) -> CreateTrialFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateTrialFluentBuilder
impl !RefUnwindSafe for CreateTrialFluentBuilder
impl Send for CreateTrialFluentBuilder
impl Sync for CreateTrialFluentBuilder
impl Unpin for CreateTrialFluentBuilder
impl !UnwindSafe for CreateTrialFluentBuilder
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);