Struct aws_sdk_sagemaker::operation::create_experiment::builders::CreateExperimentFluentBuilder

pub struct CreateExperimentFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateExperiment.

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

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 experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

Implementations

impl CreateExperimentFluentBuilder

pub fn as_input(&self) -> &CreateExperimentInputBuilder

Access the CreateExperiment as a reference.

pub async fn send( self, ) -> Result<CreateExperimentOutput, SdkError<CreateExperimentError, 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.

pub fn customize( self, ) -> CustomizableOperation<CreateExperimentOutput, CreateExperimentError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

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

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

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

pub fn get_experiment_name(&self) -> &Option<String>

The name of the experiment. 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 experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

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

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

pub fn get_display_name(&self) -> &Option<String>

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

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

The description of the experiment.

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

The description of the experiment.

pub fn get_description(&self) -> &Option<String>

The description of the experiment.

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 experiment. 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 experiment. You can use Search API to search on the tags.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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

Trait Implementations

impl Clone for CreateExperimentFluentBuilder

fn clone(&self) -> CreateExperimentFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateExperimentFluentBuilder

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

Formats the value using the given formatter.