AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateTrialComponent operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.CreateTrialComponentRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class CreateTrialComponentRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The CreateTrialComponentRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DisplayName System.String

Gets and sets the property DisplayName.

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

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

When the component ended.

Public Property InputArtifacts System.Collections.Generic.Dictionary<System.String, Amazon.SageMaker.Model.TrialComponentArtifact>

Gets and sets the property InputArtifacts.

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

Public Property MetadataProperties Amazon.SageMaker.Model.MetadataProperties

Gets and sets the property MetadataProperties.

Public Property OutputArtifacts System.Collections.Generic.Dictionary<System.String, Amazon.SageMaker.Model.TrialComponentArtifact>

Gets and sets the property OutputArtifacts.

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

Public Property Parameters System.Collections.Generic.Dictionary<System.String, Amazon.SageMaker.Model.TrialComponentParameterValue>

Gets and sets the property Parameters.

The hyperparameters for the component.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

When the component started.

Public Property Status Amazon.SageMaker.Model.TrialComponentStatus

Gets and sets the property Status.

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

Public Property Tags System.Collections.Generic.List<Amazon.SageMaker.Model.Tag>

Gets and sets the property Tags.

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

Public Property TrialComponentName System.String

Gets and sets the property TrialComponentName.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5