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

Interface CfnModelCardPropsMixin.EvaluationDetailProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCardPropsMixin.EvaluationDetailProperty.Jsii$Proxy

Enclosing class:

CfnModelCardPropsMixin

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

The evaluation details of the 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.cfnpropertymixins.services.sagemaker.*;
 Object value;
 EvaluationDetailProperty evaluationDetailProperty = EvaluationDetailProperty.builder()
         .datasets(List.of("datasets"))
         .evaluationJobArn("evaluationJobArn")
         .evaluationObservation("evaluationObservation")
         .metadata(Map.of(
                 "metadataKey", "metadata"))
         .metricGroups(List.of(MetricGroupProperty.builder()
                 .metricData(List.of(MetricDataItemsProperty.builder()
                         .name("name")
                         .notes("notes")
                         .type("type")
                         .value(value)
                         .xAxisName(List.of("xAxisName"))
                         .yAxisName(List.of("yAxisName"))
                         .build()))
                 .name("name")
                 .build()))
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCardPropsMixin.EvaluationDetailProperty.Builder	builder()
default List<String>	getDatasets()	The location of the datasets used to evaluate the model.
default String	getEvaluationJobArn()	The Amazon Resource Name (ARN) of the evaluation job.
default String	getEvaluationObservation()	Any observations made during the model evaluation.
default Object	getMetadata()	Additional attributes associated with the evaluation results.
default Object	getMetricGroups()	An evaluation Metric Group object.
default String	getName()	The evaluation job name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasets

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

The location of the datasets used to evaluate the model.

See Also:

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

getEvaluationJobArn

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

The Amazon Resource Name (ARN) of the evaluation job.

See Also:

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

getEvaluationObservation

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

Any observations made during the model evaluation.

See Also:

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

getMetadata

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

Additional attributes associated with the evaluation results.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getMetricGroups

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

An evaluation Metric Group object.

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

See Also:

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

getName

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

The evaluation job name.

See Also:

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

builder

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

Returns:

a CfnModelCardPropsMixin.EvaluationDetailProperty.Builder of CfnModelCardPropsMixin.EvaluationDetailProperty