interface IntendedUsesProperty

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnModelCard.IntendedUsesProperty
Java	software.amazon.awscdk.services.sagemaker.CfnModelCard.IntendedUsesProperty
Python	aws_cdk.aws_sagemaker.CfnModelCard.IntendedUsesProperty
TypeScript	@aws-cdk/aws-sagemaker » CfnModelCard » IntendedUsesProperty

The intended uses of a model.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker from '@aws-cdk/aws-sagemaker';
const intendedUsesProperty: sagemaker.CfnModelCard.IntendedUsesProperty = {
  explanationsForRiskRating: 'explanationsForRiskRating',
  factorsAffectingModelEfficiency: 'factorsAffectingModelEfficiency',
  intendedUses: 'intendedUses',
  purposeOfModel: 'purposeOfModel',
  riskRating: 'riskRating',
};

Properties

Name	Type	Description
explanationsForRiskRating?	string	An explanation of why your organization categorizes the model with its risk rating.
factorsAffectingModelEfficiency?	string	Factors affecting model efficacy.
intendedUses?	string	The intended use cases for the model.
purposeOfModel?	string	The general purpose of the model.
riskRating?	string	Your organization's risk rating. You can specify one the following values as the risk rating:.

---

explanationsForRiskRating?

Type: string (optional)

An explanation of why your organization categorizes the model with its risk rating.

---

factorsAffectingModelEfficiency?

Type: string (optional)

Factors affecting model efficacy.

---

intendedUses?

Type: string (optional)

The intended use cases for the model.

---

purposeOfModel?

Type: string (optional)

The general purpose of the model.

---

riskRating?

Type: string (optional)

Your organization's risk rating. You can specify one the following values as the risk rating:.

• High
• Medium
• Low
• Unknown