Class CfnModelCardProps

Properties for defining a CfnModelCard.

Inheritance

object

CfnModelCardProps

Implements

ICfnModelCardProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnModelCardProps : ICfnModelCardProps

Syntax (vb)

Public Class CfnModelCardProps Implements ICfnModelCardProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html

ExampleMetadata: fixture=_generated

Examples

// 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 cfnModelCardProps = new CfnModelCardProps {
                 Content = new ContentProperty {
                     AdditionalInformation = new AdditionalInformationProperty {
                         CaveatsAndRecommendations = "caveatsAndRecommendations",
                         CustomDetails = new Dictionary<string, string> {
                             { "customDetailsKey", "customDetails" }
                         },
                         EthicalConsiderations = "ethicalConsiderations"
                     },
                     BusinessDetails = new BusinessDetailsProperty {
                         BusinessProblem = "businessProblem",
                         BusinessStakeholders = "businessStakeholders",
                         LineOfBusiness = "lineOfBusiness"
                     },
                     EvaluationDetails = new [] { 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"
                         } }
                     } },
                     IntendedUses = new IntendedUsesProperty {
                         ExplanationsForRiskRating = "explanationsForRiskRating",
                         FactorsAffectingModelEfficiency = "factorsAffectingModelEfficiency",
                         IntendedUses = "intendedUses",
                         PurposeOfModel = "purposeOfModel",
                         RiskRating = "riskRating"
                     },
                     ModelOverview = new ModelOverviewProperty {
                         AlgorithmType = "algorithmType",
                         InferenceEnvironment = new InferenceEnvironmentProperty {
                             ContainerImage = new [] { "containerImage" }
                         },
                         ModelArtifact = new [] { "modelArtifact" },
                         ModelCreator = "modelCreator",
                         ModelDescription = "modelDescription",
                         ModelId = "modelId",
                         ModelName = "modelName",
                         ModelOwner = "modelOwner",
                         ModelVersion = 123,
                         ProblemType = "problemType"
                     },
                     ModelPackageDetails = new ModelPackageDetailsProperty {
                         ApprovalDescription = "approvalDescription",
                         CreatedBy = new ModelPackageCreatorProperty {
                             UserProfileName = "userProfileName"
                         },
                         Domain = "domain",
                         InferenceSpecification = new InferenceSpecificationProperty {
                             Containers = new [] { new ContainerProperty {
                                 Image = "image",

                                 // the properties below are optional
                                 ModelDataUrl = "modelDataUrl",
                                 NearestModelName = "nearestModelName"
                             } }
                         },
                         ModelApprovalStatus = "modelApprovalStatus",
                         ModelPackageArn = "modelPackageArn",
                         ModelPackageDescription = "modelPackageDescription",
                         ModelPackageGroupName = "modelPackageGroupName",
                         ModelPackageName = "modelPackageName",
                         ModelPackageStatus = "modelPackageStatus",
                         ModelPackageVersion = 123,
                         SourceAlgorithms = new [] { new SourceAlgorithmProperty {
                             AlgorithmName = "algorithmName",

                             // the properties below are optional
                             ModelDataUrl = "modelDataUrl"
                         } },
                         Task = "task"
                     },
                     TrainingDetails = new TrainingDetailsProperty {
                         ObjectiveFunction = new ObjectiveFunctionProperty {
                             Function = new FunctionProperty {
                                 Condition = "condition",
                                 Facet = "facet",
                                 Function = "function"
                             },
                             Notes = "notes"
                         },
                         TrainingJobDetails = new TrainingJobDetailsProperty {
                             HyperParameters = new [] { new TrainingHyperParameterProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             TrainingArn = "trainingArn",
                             TrainingDatasets = new [] { "trainingDatasets" },
                             TrainingEnvironment = new TrainingEnvironmentProperty {
                                 ContainerImage = new [] { "containerImage" }
                             },
                             TrainingMetrics = new [] { new TrainingMetricProperty {
                                 Name = "name",
                                 Value = 123,

                                 // the properties below are optional
                                 Notes = "notes"
                             } },
                             UserProvidedHyperParameters = new [] { new TrainingHyperParameterProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             UserProvidedTrainingMetrics = new [] { new TrainingMetricProperty {
                                 Name = "name",
                                 Value = 123,

                                 // the properties below are optional
                                 Notes = "notes"
                             } }
                         },
                         TrainingObservations = "trainingObservations"
                     }
                 },
                 ModelCardName = "modelCardName",
                 ModelCardStatus = "modelCardStatus",

                 // the properties below are optional
                 CreatedBy = new UserContextProperty {
                     DomainId = "domainId",
                     UserProfileArn = "userProfileArn",
                     UserProfileName = "userProfileName"
                 },
                 LastModifiedBy = new UserContextProperty {
                     DomainId = "domainId",
                     UserProfileArn = "userProfileArn",
                     UserProfileName = "userProfileName"
                 },
                 SecurityConfig = new SecurityConfigProperty {
                     KmsKeyId = "kmsKeyId"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnModelCardProps()

Properties for defining a CfnModelCard.

Properties

Content	The content of the model card.
CreatedBy	Information about the user who created or modified one or more of the following:.
LastModifiedBy	Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
ModelCardName	The unique name of the model card.
ModelCardStatus	The approval status of the model card within your organization.
SecurityConfig	The security configuration used to protect model card data.
Tags	Key-value pairs used to manage metadata for the model card.

Constructors

CfnModelCardProps()

Properties for defining a CfnModelCard.

public CfnModelCardProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html

ExampleMetadata: fixture=_generated

Examples

// 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 cfnModelCardProps = new CfnModelCardProps {
                 Content = new ContentProperty {
                     AdditionalInformation = new AdditionalInformationProperty {
                         CaveatsAndRecommendations = "caveatsAndRecommendations",
                         CustomDetails = new Dictionary<string, string> {
                             { "customDetailsKey", "customDetails" }
                         },
                         EthicalConsiderations = "ethicalConsiderations"
                     },
                     BusinessDetails = new BusinessDetailsProperty {
                         BusinessProblem = "businessProblem",
                         BusinessStakeholders = "businessStakeholders",
                         LineOfBusiness = "lineOfBusiness"
                     },
                     EvaluationDetails = new [] { 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"
                         } }
                     } },
                     IntendedUses = new IntendedUsesProperty {
                         ExplanationsForRiskRating = "explanationsForRiskRating",
                         FactorsAffectingModelEfficiency = "factorsAffectingModelEfficiency",
                         IntendedUses = "intendedUses",
                         PurposeOfModel = "purposeOfModel",
                         RiskRating = "riskRating"
                     },
                     ModelOverview = new ModelOverviewProperty {
                         AlgorithmType = "algorithmType",
                         InferenceEnvironment = new InferenceEnvironmentProperty {
                             ContainerImage = new [] { "containerImage" }
                         },
                         ModelArtifact = new [] { "modelArtifact" },
                         ModelCreator = "modelCreator",
                         ModelDescription = "modelDescription",
                         ModelId = "modelId",
                         ModelName = "modelName",
                         ModelOwner = "modelOwner",
                         ModelVersion = 123,
                         ProblemType = "problemType"
                     },
                     ModelPackageDetails = new ModelPackageDetailsProperty {
                         ApprovalDescription = "approvalDescription",
                         CreatedBy = new ModelPackageCreatorProperty {
                             UserProfileName = "userProfileName"
                         },
                         Domain = "domain",
                         InferenceSpecification = new InferenceSpecificationProperty {
                             Containers = new [] { new ContainerProperty {
                                 Image = "image",

                                 // the properties below are optional
                                 ModelDataUrl = "modelDataUrl",
                                 NearestModelName = "nearestModelName"
                             } }
                         },
                         ModelApprovalStatus = "modelApprovalStatus",
                         ModelPackageArn = "modelPackageArn",
                         ModelPackageDescription = "modelPackageDescription",
                         ModelPackageGroupName = "modelPackageGroupName",
                         ModelPackageName = "modelPackageName",
                         ModelPackageStatus = "modelPackageStatus",
                         ModelPackageVersion = 123,
                         SourceAlgorithms = new [] { new SourceAlgorithmProperty {
                             AlgorithmName = "algorithmName",

                             // the properties below are optional
                             ModelDataUrl = "modelDataUrl"
                         } },
                         Task = "task"
                     },
                     TrainingDetails = new TrainingDetailsProperty {
                         ObjectiveFunction = new ObjectiveFunctionProperty {
                             Function = new FunctionProperty {
                                 Condition = "condition",
                                 Facet = "facet",
                                 Function = "function"
                             },
                             Notes = "notes"
                         },
                         TrainingJobDetails = new TrainingJobDetailsProperty {
                             HyperParameters = new [] { new TrainingHyperParameterProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             TrainingArn = "trainingArn",
                             TrainingDatasets = new [] { "trainingDatasets" },
                             TrainingEnvironment = new TrainingEnvironmentProperty {
                                 ContainerImage = new [] { "containerImage" }
                             },
                             TrainingMetrics = new [] { new TrainingMetricProperty {
                                 Name = "name",
                                 Value = 123,

                                 // the properties below are optional
                                 Notes = "notes"
                             } },
                             UserProvidedHyperParameters = new [] { new TrainingHyperParameterProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             UserProvidedTrainingMetrics = new [] { new TrainingMetricProperty {
                                 Name = "name",
                                 Value = 123,

                                 // the properties below are optional
                                 Notes = "notes"
                             } }
                         },
                         TrainingObservations = "trainingObservations"
                     }
                 },
                 ModelCardName = "modelCardName",
                 ModelCardStatus = "modelCardStatus",

                 // the properties below are optional
                 CreatedBy = new UserContextProperty {
                     DomainId = "domainId",
                     UserProfileArn = "userProfileArn",
                     UserProfileName = "userProfileName"
                 },
                 LastModifiedBy = new UserContextProperty {
                     DomainId = "domainId",
                     UserProfileArn = "userProfileArn",
                     UserProfileName = "userProfileName"
                 },
                 SecurityConfig = new SecurityConfigProperty {
                     KmsKeyId = "kmsKeyId"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Content

The content of the model card.

public object Content { get; set; }

Property Value

object

Remarks

Content uses the model card JSON schema .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-content

CreatedBy

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

public object? CreatedBy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-createdby

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

public object? LastModifiedBy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-lastmodifiedby

ModelCardName

The unique name of the model card.

public string ModelCardName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardname

ModelCardStatus

The approval status of the model card within your organization.

public string ModelCardStatus { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardstatus

SecurityConfig

The security configuration used to protect model card data.

public object? SecurityConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-securityconfig

Tags

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

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-tags

Implements

ICfnModelCardProps