Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.MetricDataItemsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCard.MetricDataItemsProperty.Jsii$Proxy

Enclosing class:

CfnModelCard

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

Metric data.

The type determines the data types that you specify for value , XAxisName and YAxisName . For information about specifying values for metrics, see model card JSON schema .

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCard.MetricDataItemsProperty.Builder	builder()
String	getName()	The names of the metrics.
default String	getNotes()	Any notes to add to the metric.
String	getType()	You must specify one of the following data types:.
Object	getValue()	The datatype of the metric.
default List<String>	getXAxisName()	The name of the x axis.
default List<String>	getYAxisName()	The name of the y axis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The names of the metrics.

getType

@Stability(Stable)
@NotNull
String getType()

You must specify one of the following data types:.

• Bar Chart bar_char
• Boolean boolean
• Linear Graph linear_graph
• Matrix matrix
• Number number
• String string

getValue

@Stability(Stable)
@NotNull
Object getValue()

The datatype of the metric.

The metric's value must be compatible with the metric's type .

getNotes

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

Any notes to add to the metric.

getXAxisName

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

The name of the x axis.

getYAxisName

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

The name of the y axis.

builder

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

Returns:

a CfnModelCard.MetricDataItemsProperty.Builder of CfnModelCard.MetricDataItemsProperty