Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:35.324Z")
@Stability(Stable)
public interface CfnModelCardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnModelCard.

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;
 CfnModelCardProps cfnModelCardProps = CfnModelCardProps.builder()
         .content(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())
         .modelCardName("modelCardName")
         .modelCardStatus("modelCardStatus")
         // the properties below are optional
         .createdBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .lastModifiedBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .securityConfig(SecurityConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCardProps.Builder	builder()
Object	getContent()	The content of the model card.
default Object	getCreatedBy()	Information about the user who created or modified one or more of the following:.
default Object	getLastModifiedBy()	AWS::SageMaker::ModelCard.LastModifiedBy.
String	getModelCardName()	The unique name of the model card.
String	getModelCardStatus()	The approval status of the model card within your organization.
default Object	getSecurityConfig()	The security configuration used to protect model card data.
default List<CfnTag>	getTags()	Key-value pairs used to manage metadata for the model card.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContent

@Stability(Stable)
@NotNull
Object getContent()

The content of the model card.

Content uses the model card JSON schema .

getModelCardName

@Stability(Stable)
@NotNull
String getModelCardName()

The unique name of the model card.

getModelCardStatus

@Stability(Stable)
@NotNull
String getModelCardStatus()

The approval status of the model card within your organization.

Different organizations might have different criteria for model card review and approval.

• Draft : The model card is a work in progress.
• PendingReview : The model card is pending review.
• Approved : The model card is approved.
• Archived : The model card is archived. No more updates should be made to the model card, but it can still be exported.

getCreatedBy

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

Information about the user who created or modified one or more of the following:.

• Experiment
• Trial
• Trial component
• Lineage group
• Project
• Model Card

getLastModifiedBy

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

AWS::SageMaker::ModelCard.LastModifiedBy.

getSecurityConfig

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

The security configuration used to protect model card data.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Key-value pairs used to manage metadata for the model card.

builder

@Stability(Stable)
static CfnModelCardProps.Builder builder()

Returns:

a CfnModelCardProps.Builder of CfnModelCardProps