Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.TrainingJobDetailsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnModelCard.TrainingJobDetailsProperty.Jsii$Proxy
Enclosing class:
CfnModelCard
@Stability(Stable) public static interface CfnModelCard.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.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")
                 .value(123)
                 // the properties below are optional
                 .notes("notes")
                 .build()))
         .userProvidedHyperParameters(List.of(TrainingHyperParameterProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .userProvidedTrainingMetrics(List.of(TrainingMetricProperty.builder()
                 .name("name")
                 .value(123)
                 // the properties below are optional
                 .notes("notes")
                 .build()))
         .build();

  • Method Details

    • getHyperParameters

      @Stability(Stable) @Nullable default Object getHyperParameters()
      The hyper parameters used in the training job.

    • getTrainingArn

      @Stability(Stable) @Nullable default String getTrainingArn()
      The SageMaker training job Amazon Resource Name (ARN).

    • getTrainingDatasets

      @Stability(Stable) @Nullable default List<String> getTrainingDatasets()
      The location of the datasets used to train the model.

    • getTrainingEnvironment

      @Stability(Stable) @Nullable default Object getTrainingEnvironment()
      The SageMaker training job image URI.

    • getTrainingMetrics

      @Stability(Stable) @Nullable default Object getTrainingMetrics()
      The SageMaker training job results.

    • getUserProvidedHyperParameters

      @Stability(Stable) @Nullable default Object getUserProvidedHyperParameters()
      Additional hyper parameters that you've specified when training the model.

    • getUserProvidedTrainingMetrics

      @Stability(Stable) @Nullable default Object getUserProvidedTrainingMetrics()
      Custom training job results.

    • builder

      @Stability(Stable) static CfnModelCard.TrainingJobDetailsProperty.Builder builder()
      Returns:
      a CfnModelCard.TrainingJobDetailsProperty.Builder of CfnModelCard.TrainingJobDetailsProperty