Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.MetricGroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCard.MetricGroupProperty.Jsii$Proxy

Enclosing class:

CfnModelCard

@Stability(Stable)
public static interface CfnModelCard.MetricGroupProperty
extends software.amazon.jsii.JsiiSerializable

A group of metric data that you use to initialize a metric group object.

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.*;
 Object value;
 MetricGroupProperty metricGroupProperty = MetricGroupProperty.builder()
         .metricData(List.of(MetricDataItemsProperty.builder()
                 .name("name")
                 .type("type")
                 .value(value)
                 // the properties below are optional
                 .notes("notes")
                 .xAxisName(List.of("xAxisName"))
                 .yAxisName(List.of("yAxisName"))
                 .build()))
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCard.MetricGroupProperty.Builder	builder()
Object	getMetricData()	A list of metric objects.
String	getName()	The metric group name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricData

@Stability(Stable)
@NotNull
Object getMetricData()

A list of metric objects. The MetricDataItems list can have one of the following values:.

• bar_chart_metric
• matrix_metric
• simple_metric
• linear_graph_metric

For more information about the metric schema, see the definition section of the model card JSON schema .

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The metric group name.

See Also:

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

builder

@Stability(Stable)
static CfnModelCard.MetricGroupProperty.Builder builder()

Returns:

a CfnModelCard.MetricGroupProperty.Builder of CfnModelCard.MetricGroupProperty