Struct aws_sdk_sagemaker::client::fluent_builders::CreateTrialComponent

pub struct CreateTrialComponent { /* private fields */ }

Fluent builder constructing a request to CreateTrialComponent.

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

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 component and then use the Search API to search for the tags.

Implementations

impl CreateTrialComponent

pub async fn send(
    self
) -> Result<CreateTrialComponentOutput, SdkError<CreateTrialComponentError>>

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.

pub fn trial_component_name(self, input: impl Into<String>) -> Self

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

pub fn set_trial_component_name(self, input: Option<String>) -> Self

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

pub fn display_name(self, input: impl Into<String>) -> Self

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

pub fn set_display_name(self, input: Option<String>) -> Self

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

pub fn status(self, input: TrialComponentStatus) -> Self

The status of the component. States include:

• InProgress

• Completed

• Failed

pub fn set_status(self, input: Option<TrialComponentStatus>) -> Self

The status of the component. States include:

• InProgress

• Completed

• Failed

pub fn start_time(self, input: DateTime) -> Self

When the component started.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

When the component started.

pub fn end_time(self, input: DateTime) -> Self

When the component ended.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

When the component ended.

pub fn parameters(
    self,
    k: impl Into<String>,
    v: TrialComponentParameterValue
) -> Self

Adds a key-value pair to Parameters.

To override the contents of this collection use set_parameters.

The hyperparameters for the component.

pub fn set_parameters(
    self,
    input: Option<HashMap<String, TrialComponentParameterValue>>
) -> Self

The hyperparameters for the component.

pub fn input_artifacts(
    self,
    k: impl Into<String>,
    v: TrialComponentArtifact
) -> Self

Adds a key-value pair to InputArtifacts.

To override the contents of this collection use set_input_artifacts.

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

pub fn set_input_artifacts(
    self,
    input: Option<HashMap<String, TrialComponentArtifact>>
) -> Self

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

pub fn output_artifacts(
    self,
    k: impl Into<String>,
    v: TrialComponentArtifact
) -> Self

Adds a key-value pair to OutputArtifacts.

To override the contents of this collection use set_output_artifacts.

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

pub fn set_output_artifacts(
    self,
    input: Option<HashMap<String, TrialComponentArtifact>>
) -> Self

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

pub fn metadata_properties(self, input: MetadataProperties) -> Self

Metadata properties of the tracking entity, trial, or trial component.

pub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self

Metadata properties of the tracking entity, trial, or trial component.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of tags to associate with the component. You can use Search API to search on the tags.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags to associate with the component. You can use Search API to search on the tags.

Trait Implementations

impl Clone for CreateTrialComponent

fn clone(&self) -> CreateTrialComponent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateTrialComponent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.