Interface CfnModelCard.ContentProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnModelCard.ContentProperty.Jsii$Proxy
- Enclosing class:
CfnModelCard
@Stability(Stable)
public static interface CfnModelCard.ContentProperty
extends software.amazon.jsii.JsiiSerializable
The content of the model card.
It follows the 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; ContentProperty contentProperty = ContentProperty.builder() .additionalInformation(AdditionalInformationProperty.builder() .caveatsAndRecommendations("caveatsAndRecommendations") .customDetails(Map.of( "customDetailsKey", "customDetails")) .ethicalConsiderations("ethicalConsiderations") .build()) .businessDetails(BusinessDetailsProperty.builder() .businessProblem("businessProblem") .businessStakeholders("businessStakeholders") .lineOfBusiness("lineOfBusiness") .build()) .evaluationDetails(List.of(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())) .intendedUses(IntendedUsesProperty.builder() .explanationsForRiskRating("explanationsForRiskRating") .factorsAffectingModelEfficiency("factorsAffectingModelEfficiency") .intendedUses("intendedUses") .purposeOfModel("purposeOfModel") .riskRating("riskRating") .build()) .modelOverview(ModelOverviewProperty.builder() .algorithmType("algorithmType") .inferenceEnvironment(InferenceEnvironmentProperty.builder() .containerImage(List.of("containerImage")) .build()) .modelArtifact(List.of("modelArtifact")) .modelCreator("modelCreator") .modelDescription("modelDescription") .modelId("modelId") .modelName("modelName") .modelOwner("modelOwner") .modelVersion(123) .problemType("problemType") .build()) .modelPackageDetails(ModelPackageDetailsProperty.builder() .approvalDescription("approvalDescription") .createdBy(ModelPackageCreatorProperty.builder() .userProfileName("userProfileName") .build()) .domain("domain") .inferenceSpecification(InferenceSpecificationProperty.builder() .containers(List.of(ContainerProperty.builder() .image("image") // the properties below are optional .modelDataUrl("modelDataUrl") .nearestModelName("nearestModelName") .build())) .build()) .modelApprovalStatus("modelApprovalStatus") .modelPackageArn("modelPackageArn") .modelPackageDescription("modelPackageDescription") .modelPackageGroupName("modelPackageGroupName") .modelPackageName("modelPackageName") .modelPackageStatus("modelPackageStatus") .modelPackageVersion(123) .sourceAlgorithms(List.of(SourceAlgorithmProperty.builder() .algorithmName("algorithmName") // the properties below are optional .modelDataUrl("modelDataUrl") .build())) .task("task") .build()) .trainingDetails(TrainingDetailsProperty.builder() .objectiveFunction(ObjectiveFunctionProperty.builder() .function(FunctionProperty.builder() .condition("condition") .facet("facet") .function("function") .build()) .notes("notes") .build()) .trainingJobDetails(TrainingJobDetailsProperty.builder() .hyperParameters(List.of(TrainingHyperParameterProperty.builder() .name("name") .value("value") .build())) .trainingArn("trainingArn") .trainingDatasets(List.of("trainingDatasets")) .trainingEnvironment(TrainingEnvironmentProperty.builder() .containerImage(List.of("containerImage")) .build()) .trainingMetrics(List.of(TrainingMetricProperty.builder() .name("name") .value(123) // the properties below are optional .notes("notes") .build())) .userProvidedHyperParameters(List.of(TrainingHyperParameterProperty.builder() .name("name") .value("value") .build())) .userProvidedTrainingMetrics(List.of(TrainingMetricProperty.builder() .name("name") .value(123) // the properties below are optional .notes("notes") .build())) .build()) .trainingObservations("trainingObservations") .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnModelCard.ContentProperty
static final class
An implementation forCfnModelCard.ContentProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Additional information about the model.default Object
Information about how the model supports business goals.default Object
An overview about the model's evaluation.default Object
The intended usage of the model.default Object
An overview about the model.default Object
Metadata information related to model package version.default Object
An overview about model training.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAdditionalInformation
Additional information about the model.- See Also:
-
getBusinessDetails
Information about how the model supports business goals.- See Also:
-
getEvaluationDetails
An overview about the model's evaluation.- See Also:
-
getIntendedUses
The intended usage of the model.- See Also:
-
getModelOverview
An overview about the model.- See Also:
-
getModelPackageDetails
Metadata information related to model package version.- See Also:
-
getTrainingDetails
An overview about model training.- See Also:
-
builder
-