Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnModelCardPropsMixin.TrainingJobDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCardPropsMixin.TrainingJobDetailsProperty.Jsii$Proxy

Enclosing class:

CfnModelCardPropsMixin

@Stability(Stable)
public static interface CfnModelCardPropsMixin.TrainingJobDetailsProperty
extends software.amazon.jsii.JsiiSerializable

The overview of a training job.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 TrainingJobDetailsProperty trainingJobDetailsProperty = TrainingJobDetailsProperty.builder()
         .hyperParameters(List.of(TrainingHyperParameterProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .trainingArn("trainingArn")
         .trainingDatasets(List.of("trainingDatasets"))
         .trainingEnvironment(TrainingEnvironmentProperty.builder()
                 .containerImage(List.of("containerImage"))
                 .build())
         .trainingMetrics(List.of(TrainingMetricProperty.builder()
                 .name("name")
                 .notes("notes")
                 .value(123)
                 .build()))
         .userProvidedHyperParameters(List.of(TrainingHyperParameterProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .userProvidedTrainingMetrics(List.of(TrainingMetricProperty.builder()
                 .name("name")
                 .notes("notes")
                 .value(123)
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelCardPropsMixin.TrainingJobDetailsProperty.Builder	A builder for CfnModelCardPropsMixin.TrainingJobDetailsProperty
static final class	CfnModelCardPropsMixin.TrainingJobDetailsProperty.Jsii$Proxy	An implementation for CfnModelCardPropsMixin.TrainingJobDetailsProperty

Method Summary

Modifier and Type	Method	Description
static CfnModelCardPropsMixin.TrainingJobDetailsProperty.Builder	builder()
default Object	getHyperParameters()	The hyper parameters used in the training job.
default String	getTrainingArn()	The SageMaker AI training job Amazon Resource Name (ARN).
default List<String>	getTrainingDatasets()	The location of the datasets used to train the model.
default Object	getTrainingEnvironment()	The SageMaker AI training job image URI.
default Object	getTrainingMetrics()	The SageMaker AI training job results.
default Object	getUserProvidedHyperParameters()	Additional hyper parameters that you've specified when training the model.
default Object	getUserProvidedTrainingMetrics()	Custom training job results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHyperParameters

@Stability(Stable)
@Nullable
default Object getHyperParameters()

The hyper parameters used in the training job.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnModelCardPropsMixin.TrainingHyperParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-hyperparameters

getTrainingArn

@Stability(Stable)
@Nullable
default String getTrainingArn()

The SageMaker AI training job Amazon Resource Name (ARN).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingarn

getTrainingDatasets

@Stability(Stable)
@Nullable
default List<String> getTrainingDatasets()

The location of the datasets used to train the model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingdatasets

getTrainingEnvironment

@Stability(Stable)
@Nullable
default Object getTrainingEnvironment()

The SageMaker AI training job image URI.

Returns union: either IResolvable or CfnModelCardPropsMixin.TrainingEnvironmentProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingenvironment

getTrainingMetrics

@Stability(Stable)
@Nullable
default Object getTrainingMetrics()

The SageMaker AI training job results.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnModelCardPropsMixin.TrainingMetricProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingmetrics

getUserProvidedHyperParameters

@Stability(Stable)
@Nullable
default Object getUserProvidedHyperParameters()

Additional hyper parameters that you've specified when training the model.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnModelCardPropsMixin.TrainingHyperParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedhyperparameters

getUserProvidedTrainingMetrics

@Stability(Stable)
@Nullable
default Object getUserProvidedTrainingMetrics()

Custom training job results.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnModelCardPropsMixin.TrainingMetricProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedtrainingmetrics

builder

@Stability(Stable)
static CfnModelCardPropsMixin.TrainingJobDetailsProperty.Builder builder()

Returns:

a CfnModelCardPropsMixin.TrainingJobDetailsProperty.Builder of CfnModelCardPropsMixin.TrainingJobDetailsProperty