Class CfnModelCard
Creates an Amazon SageMaker Model Card.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnModelCard : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnModelCard
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For information about how to use model cards, see Amazon SageMaker Model Card .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html
CloudformationResource: AWS::SageMaker::ModelCard
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 cfnModelCard = new CfnModelCard(this, "MyCfnModelCard", 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
CfnModelCard(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnModelCard(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnModelCard(Construct, String, ICfnModelCardProps) |
Properties
AttrCreatedByDomainId | The domain associated with the user. |
AttrCreatedByUserProfileArn | The Amazon Resource Name (ARN) of the user's profile. |
AttrCreatedByUserProfileName | The name of the user's profile. |
AttrCreationTime | The date and time the model card was created. |
AttrLastModifiedByDomainId | The domain associated with the user. |
AttrLastModifiedByUserProfileArn | The Amazon Resource Name (ARN) of the user's profile. |
AttrLastModifiedByUserProfileName | The name of the user's profile. |
AttrLastModifiedTime | The date and time the model card was last modified. |
AttrModelCardArn | The Amazon Resource Number (ARN) of the model card. |
AttrModelCardProcessingStatus | The processing status of model card deletion. |
AttrModelCardVersion | A version of the model card. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | Key-value pairs used to manage metadata for the model card. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnModelCard(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnModelCard(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnModelCard(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnModelCard(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnModelCard(Construct, String, ICfnModelCardProps)
public CfnModelCard(Construct scope, string id, ICfnModelCardProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnModelCardProps
Resource properties.
Properties
AttrCreatedByDomainId
The domain associated with the user.
public virtual string AttrCreatedByDomainId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedBy.DomainId
AttrCreatedByUserProfileArn
The Amazon Resource Name (ARN) of the user's profile.
public virtual string AttrCreatedByUserProfileArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedBy.UserProfileArn
AttrCreatedByUserProfileName
The name of the user's profile.
public virtual string AttrCreatedByUserProfileName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedBy.UserProfileName
AttrCreationTime
The date and time the model card was created.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationTime
AttrLastModifiedByDomainId
The domain associated with the user.
public virtual string AttrLastModifiedByDomainId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastModifiedBy.DomainId
AttrLastModifiedByUserProfileArn
The Amazon Resource Name (ARN) of the user's profile.
public virtual string AttrLastModifiedByUserProfileArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastModifiedBy.UserProfileArn
AttrLastModifiedByUserProfileName
The name of the user's profile.
public virtual string AttrLastModifiedByUserProfileName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastModifiedBy.UserProfileName
AttrLastModifiedTime
The date and time the model card was last modified.
public virtual string AttrLastModifiedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastModifiedTime
AttrModelCardArn
The Amazon Resource Number (ARN) of the model card.
public virtual string AttrModelCardArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard
.
CloudformationAttribute: ModelCardArn
AttrModelCardProcessingStatus
The processing status of model card deletion.
public virtual string AttrModelCardProcessingStatus { get; }
Property Value
System.String
Remarks
The ModelCardProcessingStatus updates throughout the different deletion steps.
CloudformationAttribute: ModelCardProcessingStatus
AttrModelCardVersion
A version of the model card.
public virtual double AttrModelCardVersion { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: ModelCardVersion
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Content
The content of the model card.
public virtual object Content { get; set; }
Property Value
System.Object
CreatedBy
Information about the user who created or modified one or more of the following:.
public virtual object CreatedBy { get; set; }
Property Value
System.Object
LastModifiedBy
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
public virtual object LastModifiedBy { get; set; }
Property Value
System.Object
ModelCardName
The unique name of the model card.
public virtual string ModelCardName { get; set; }
Property Value
System.String
ModelCardStatus
The approval status of the model card within your organization.
public virtual string ModelCardStatus { get; set; }
Property Value
System.String
SecurityConfig
The security configuration used to protect model card data.
public virtual object SecurityConfig { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Key-value pairs used to manage metadata for the model card.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>