Package software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.ModelMetricsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelPackage.ModelMetricsProperty.Jsii$Proxy

Enclosing class:

CfnModelPackage

@Stability(Stable)
public static interface CfnModelPackage.ModelMetricsProperty
extends software.amazon.jsii.JsiiSerializable

Contains metrics captured from a model.

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.*;
 ModelMetricsProperty modelMetricsProperty = ModelMetricsProperty.builder()
         .bias(BiasProperty.builder()
                 .postTrainingReport(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .preTrainingReport(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .report(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .build())
         .explainability(ExplainabilityProperty.builder()
                 .report(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .build())
         .modelDataQuality(ModelDataQualityProperty.builder()
                 .constraints(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .statistics(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .build())
         .modelQuality(ModelQualityProperty.builder()
                 .constraints(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .statistics(MetricsSourceProperty.builder()
                         .contentType("contentType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .contentDigest("contentDigest")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelPackage.ModelMetricsProperty.Builder	builder()
default Object	getBias()	Metrics that measure bias in a model.
default Object	getExplainability()	Metrics that help explain a model.
default Object	getModelDataQuality()	Metrics that measure the quality of the input data for a model.
default Object	getModelQuality()	Metrics that measure the quality of a model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBias

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

Metrics that measure bias in a model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-bias

getExplainability

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

Metrics that help explain a model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-explainability

getModelDataQuality

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

Metrics that measure the quality of the input data for a model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-modeldataquality

getModelQuality

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

Metrics that measure the quality of a model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-modelquality

builder

@Stability(Stable)
static CfnModelPackage.ModelMetricsProperty.Builder builder()

Returns:

a CfnModelPackage.ModelMetricsProperty.Builder of CfnModelPackage.ModelMetricsProperty