Skip to content
v2.277.0

EvaluationDetailProperty Struct ​

The evaluation details of the model.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';

declare const value: any;
const evaluationDetailProperty: sagemaker.CfnModelCard.EvaluationDetailProperty = {
  name: 'name',

  // the properties below are optional
  datasets: ['datasets'],
  evaluationJobArn: 'evaluationJobArn',
  evaluationObservation: 'evaluationObservation',
  metadata: {
    metadataKey: 'metadata',
  },
  metricGroups: [{
    metricData: [{
      name: 'name',
      type: 'type',
      value: value,

      // the properties below are optional
      notes: 'notes',
      xAxisName: ['xAxisName'],
      yAxisName: ['yAxisName'],
    }],
    name: 'name',
  }],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

# value: Any

evaluation_detail_property = sagemaker.CfnModelCard.EvaluationDetailProperty(
    name="name",

    # the properties below are optional
    datasets=["datasets"],
    evaluation_job_arn="evaluationJobArn",
    evaluation_observation="evaluationObservation",
    metadata={
        "metadata_key": "metadata"
    },
    metric_groups=[sagemaker.CfnModelCard.MetricGroupProperty(
        metric_data=[sagemaker.CfnModelCard.MetricDataItemsProperty(
            name="name",
            type="type",
            value=value,

            # the properties below are optional
            notes="notes",
            x_axis_name=["xAxisName"],
            y_axis_name=["yAxisName"]
        )],
        name="name"
    )]
)
java
// 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;

EvaluationDetailProperty evaluationDetailProperty = EvaluationDetailProperty.builder()
        .name("name")

        // the properties below are optional
        .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")
                        .type("type")
                        .value(value)

                        // the properties below are optional
                        .notes("notes")
                        .xAxisName(List.of("xAxisName"))
                        .yAxisName(List.of("yAxisName"))
                        .build()))
                .name("name")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var value;

var evaluationDetailProperty = new EvaluationDetailProperty {
    Name = "name",

    // the properties below are optional
    Datasets = new [] { "datasets" },
    EvaluationJobArn = "evaluationJobArn",
    EvaluationObservation = "evaluationObservation",
    Metadata = new Dictionary<string, string> {
        { "metadataKey", "metadata" }
    },
    MetricGroups = new [] { new MetricGroupProperty {
        MetricData = new [] { new MetricDataItemsProperty {
            Name = "name",
            Type = "type",
            Value = value,

            // the properties below are optional
            Notes = "notes",
            XAxisName = new [] { "xAxisName" },
            YAxisName = new [] { "yAxisName" }
        } },
        Name = "name"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var value interface{}

evaluationDetailProperty := &EvaluationDetailProperty{
	Name: jsii.String("name"),

	// the properties below are optional
	Datasets: []*string{
		jsii.String("datasets"),
	},
	EvaluationJobArn: jsii.String("evaluationJobArn"),
	EvaluationObservation: jsii.String("evaluationObservation"),
	Metadata: map[string]*string{
		"metadataKey": jsii.String("metadata"),
	},
	MetricGroups: []interface{}{
		&MetricGroupProperty{
			MetricData: []interface{}{
				&MetricDataItemsProperty{
					Name: jsii.String("name"),
					Type: jsii.String("type"),
					Value: value,

					// the properties below are optional
					Notes: jsii.String("notes"),
					XAxisName: []*string{
						jsii.String("xAxisName"),
					},
					YAxisName: []*string{
						jsii.String("yAxisName"),
					},
				},
			},
			Name: jsii.String("name"),
		},
	},
}

Properties ​

datasetsoptionalstring[]datasetsoptionaltyping.List[str]datasetsoptionalList<String>Datasetsoptionalstring[]Datasetsoptional*[]*string #
The location of the datasets used to evaluate the model.
evaluationJobArnoptionalstringevaluation_job_arnoptionalstrevaluationJobArnoptionalStringEvaluationJobArnoptionalstringEvaluationJobArnoptional*string #
The Amazon Resource Name (ARN) of the evaluation job.
evaluationObservationoptionalstringevaluation_observationoptionalstrevaluationObservationoptionalStringEvaluationObservationoptionalstringEvaluationObservationoptional*string #
Any observations made during the model evaluation.
metadataoptionalIResolvable | { [key: string]: string }metadataoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]metadataoptionalIResolvableMetadataoptionalIResolvableMetadataoptionalinterface{} #
Additional attributes associated with the evaluation results.
metricGroupsoptionalIResolvable | IResolvable | CfnModelCard.MetricGroupProperty[]metric_groupsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricGroupProperty]]]metricGroupsoptionalIResolvableMetricGroupsoptionalIResolvableMetricGroupsoptionalinterface{} #
An evaluation Metric Group object.
namestringnamestrnameStringNamestringName*string required #
The evaluation job name.