CfnModelCardProps

class aws_cdk.aws_sagemaker.CfnModelCardProps(*, content, model_card_name, model_card_status, created_by=None, last_modified_by=None, security_config=None, tags=None)

Bases: object

Properties for defining a CfnModelCard.

Parameters:

• content (Union[IResolvable, ContentProperty, Dict[str, Any]]) – The content of the model card. Content uses the model card JSON schema .

• model_card_name (str) – The unique name of the model card.

• model_card_status (str) – 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.

• created_by (Union[IResolvable, UserContextProperty, Dict[str, Any], None]) – Information about the user who created or modified one or more of the following:. - Experiment - Trial - Trial component - Lineage group - Project - Model Card

• last_modified_by (Union[IResolvable, UserContextProperty, Dict[str, Any], None]) – Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

• security_config (Union[IResolvable, SecurityConfigProperty, Dict[str, Any], None]) – The security configuration used to protect model card data.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Key-value pairs used to manage metadata for the model card.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

cfn_model_card_props = sagemaker.CfnModelCardProps(
    content=sagemaker.CfnModelCard.ContentProperty(
        additional_information=sagemaker.CfnModelCard.AdditionalInformationProperty(
            caveats_and_recommendations="caveatsAndRecommendations",
            custom_details={
                "custom_details_key": "customDetails"
            },
            ethical_considerations="ethicalConsiderations"
        ),
        business_details=sagemaker.CfnModelCard.BusinessDetailsProperty(
            business_problem="businessProblem",
            business_stakeholders="businessStakeholders",
            line_of_business="lineOfBusiness"
        ),
        evaluation_details=[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"
            )]
        )],
        intended_uses=sagemaker.CfnModelCard.IntendedUsesProperty(
            explanations_for_risk_rating="explanationsForRiskRating",
            factors_affecting_model_efficiency="factorsAffectingModelEfficiency",
            intended_uses="intendedUses",
            purpose_of_model="purposeOfModel",
            risk_rating="riskRating"
        ),
        model_overview=sagemaker.CfnModelCard.ModelOverviewProperty(
            algorithm_type="algorithmType",
            inference_environment=sagemaker.CfnModelCard.InferenceEnvironmentProperty(
                container_image=["containerImage"]
            ),
            model_artifact=["modelArtifact"],
            model_creator="modelCreator",
            model_description="modelDescription",
            model_id="modelId",
            model_name="modelName",
            model_owner="modelOwner",
            model_version=123,
            problem_type="problemType"
        ),
        model_package_details=sagemaker.CfnModelCard.ModelPackageDetailsProperty(
            approval_description="approvalDescription",
            created_by=sagemaker.CfnModelCard.ModelPackageCreatorProperty(
                user_profile_name="userProfileName"
            ),
            domain="domain",
            inference_specification=sagemaker.CfnModelCard.InferenceSpecificationProperty(
                containers=[sagemaker.CfnModelCard.ContainerProperty(
                    image="image",

                    # the properties below are optional
                    model_data_url="modelDataUrl",
                    nearest_model_name="nearestModelName"
                )]
            ),
            model_approval_status="modelApprovalStatus",
            model_package_arn="modelPackageArn",
            model_package_description="modelPackageDescription",
            model_package_group_name="modelPackageGroupName",
            model_package_name="modelPackageName",
            model_package_status="modelPackageStatus",
            model_package_version=123,
            source_algorithms=[sagemaker.CfnModelCard.SourceAlgorithmProperty(
                algorithm_name="algorithmName",

                # the properties below are optional
                model_data_url="modelDataUrl"
            )],
            task="task"
        ),
        training_details=sagemaker.CfnModelCard.TrainingDetailsProperty(
            objective_function=sagemaker.CfnModelCard.ObjectiveFunctionProperty(
                function=sagemaker.CfnModelCard.FunctionProperty(
                    condition="condition",
                    facet="facet",
                    function="function"
                ),
                notes="notes"
            ),
            training_job_details=sagemaker.CfnModelCard.TrainingJobDetailsProperty(
                hyper_parameters=[sagemaker.CfnModelCard.TrainingHyperParameterProperty(
                    name="name",
                    value="value"
                )],
                training_arn="trainingArn",
                training_datasets=["trainingDatasets"],
                training_environment=sagemaker.CfnModelCard.TrainingEnvironmentProperty(
                    container_image=["containerImage"]
                ),
                training_metrics=[sagemaker.CfnModelCard.TrainingMetricProperty(
                    name="name",
                    value=123,

                    # the properties below are optional
                    notes="notes"
                )],
                user_provided_hyper_parameters=[sagemaker.CfnModelCard.TrainingHyperParameterProperty(
                    name="name",
                    value="value"
                )],
                user_provided_training_metrics=[sagemaker.CfnModelCard.TrainingMetricProperty(
                    name="name",
                    value=123,

                    # the properties below are optional
                    notes="notes"
                )]
            ),
            training_observations="trainingObservations"
        )
    ),
    model_card_name="modelCardName",
    model_card_status="modelCardStatus",

    # the properties below are optional
    created_by=sagemaker.CfnModelCard.UserContextProperty(
        domain_id="domainId",
        user_profile_arn="userProfileArn",
        user_profile_name="userProfileName"
    ),
    last_modified_by=sagemaker.CfnModelCard.UserContextProperty(
        domain_id="domainId",
        user_profile_arn="userProfileArn",
        user_profile_name="userProfileName"
    ),
    security_config=sagemaker.CfnModelCard.SecurityConfigProperty(
        kms_key_id="kmsKeyId"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

content

The content of the model card.

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

created_by

.

• Experiment

• Trial

• Trial component

• Lineage group

• Project

• Model Card

See:

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

Type:

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

last_modified_by

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

See:

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

model_card_name

The unique name of the model card.

See:

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

model_card_status

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.

See:

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

security_config

The security configuration used to protect model card data.

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.

See:

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