Class: AWSCDK::Sagemaker::CfnModelCard::IntendedUsesProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Sagemaker::CfnModelCard::IntendedUsesProperty

Defined in:

sagemaker/cfn_model_card.rb

Overview

The intended uses of a model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html

Instance Attribute Summary

• #explanations_for_risk_rating ⇒ String^? readonly

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

• #factors_affecting_model_efficiency ⇒ String^? readonly

  Factors affecting model efficacy.

• #intended_uses ⇒ String^? readonly

  The intended use cases for the model.

• #purpose_of_model ⇒ String^? readonly

  The general purpose of the model.

• #risk_rating ⇒ String^? readonly

  Your organization's risk rating.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(explanations_for_risk_rating: nil, factors_affecting_model_efficiency: nil, intended_uses: nil, purpose_of_model: nil, risk_rating: nil) ⇒ IntendedUsesProperty constructor

  A new instance of IntendedUsesProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(explanations_for_risk_rating: nil, factors_affecting_model_efficiency: nil, intended_uses: nil, purpose_of_model: nil, risk_rating: nil) ⇒ IntendedUsesProperty

Returns a new instance of IntendedUsesProperty.

Parameters:

• explanations_for_risk_rating (String, nil) (defaults to: nil) —

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

• factors_affecting_model_efficiency (String, nil) (defaults to: nil) —

  Factors affecting model efficacy.

• intended_uses (String, nil) (defaults to: nil) —

  The intended use cases for the model.

• purpose_of_model (String, nil) (defaults to: nil) —

  The general purpose of the model.

• risk_rating (String, nil) (defaults to: nil) —

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

# File 'sagemaker/cfn_model_card.rb', line 1182

def initialize(explanations_for_risk_rating: nil, factors_affecting_model_efficiency: nil, intended_uses: nil, purpose_of_model: nil, risk_rating: nil)
  @explanations_for_risk_rating = explanations_for_risk_rating
  Jsii::Type.check_type(@explanations_for_risk_rating, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "explanationsForRiskRating") unless @explanations_for_risk_rating.nil?
  @factors_affecting_model_efficiency = factors_affecting_model_efficiency
  Jsii::Type.check_type(@factors_affecting_model_efficiency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "factorsAffectingModelEfficiency") unless @factors_affecting_model_efficiency.nil?
  @intended_uses = intended_uses
  Jsii::Type.check_type(@intended_uses, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "intendedUses") unless @intended_uses.nil?
  @purpose_of_model = purpose_of_model
  Jsii::Type.check_type(@purpose_of_model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "purposeOfModel") unless @purpose_of_model.nil?
  @risk_rating = risk_rating
  Jsii::Type.check_type(@risk_rating, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "riskRating") unless @risk_rating.nil?
end

Instance Attribute Details

#explanations_for_risk_rating ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-explanationsforriskrating

# File 'sagemaker/cfn_model_card.rb', line 1199

def explanations_for_risk_rating
  @explanations_for_risk_rating
end

#factors_affecting_model_efficiency ⇒ String^? (readonly)

Factors affecting model efficacy.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-factorsaffectingmodelefficiency

# File 'sagemaker/cfn_model_card.rb', line 1204

def factors_affecting_model_efficiency
  @factors_affecting_model_efficiency
end

#intended_uses ⇒ String^? (readonly)

The intended use cases for the model.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-intendeduses

# File 'sagemaker/cfn_model_card.rb', line 1209

def intended_uses
  @intended_uses
end

#purpose_of_model ⇒ String^? (readonly)

The general purpose of the model.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-purposeofmodel

# File 'sagemaker/cfn_model_card.rb', line 1214

def purpose_of_model
  @purpose_of_model
end

#risk_rating ⇒ String^? (readonly)

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

• High
• Medium
• Low
• Unknown

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-riskrating

# File 'sagemaker/cfn_model_card.rb', line 1224

def risk_rating
  @risk_rating
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sagemaker/cfn_model_card.rb', line 1226

def self.jsii_properties
  {
    :explanations_for_risk_rating => "explanationsForRiskRating",
    :factors_affecting_model_efficiency => "factorsAffectingModelEfficiency",
    :intended_uses => "intendedUses",
    :purpose_of_model => "purposeOfModel",
    :risk_rating => "riskRating",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'sagemaker/cfn_model_card.rb', line 1236

def to_jsii
  result = {}
  result.merge!({
    "explanationsForRiskRating" => @explanations_for_risk_rating,
    "factorsAffectingModelEfficiency" => @factors_affecting_model_efficiency,
    "intendedUses" => @intended_uses,
    "purposeOfModel" => @purpose_of_model,
    "riskRating" => @risk_rating,
  })
  result.compact
end