Class: AWSCDK::Sagemaker::CfnModelCard::AdditionalInformationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_model_card.rb

Overview

Additional information about the model.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(caveats_and_recommendations: nil, custom_details: nil, ethical_considerations: nil) ⇒ AdditionalInformationProperty

Returns a new instance of AdditionalInformationProperty.

Parameters:

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

    Caveats and recommendations for those who might use this model in their applications.

  • custom_details (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

    Any additional information to document about the model.

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

    Any ethical considerations documented by the model card author.



713
714
715
716
717
718
719
720
 
# File 'sagemaker/cfn_model_card.rb', line 713

def initialize(caveats_and_recommendations: nil, custom_details: nil, ethical_considerations: nil)
  @caveats_and_recommendations = caveats_and_recommendations
  Jsii::Type.check_type(@caveats_and_recommendations, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "caveatsAndRecommendations") unless @caveats_and_recommendations.nil?
  @custom_details = custom_details
  Jsii::Type.check_type(@custom_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "customDetails") unless @custom_details.nil?
  @ethical_considerations = ethical_considerations
  Jsii::Type.check_type(@ethical_considerations, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ethicalConsiderations") unless @ethical_considerations.nil?
end

Instance Attribute Details

#caveats_and_recommendations ⇒ String? (readonly)

Caveats and recommendations for those who might use this model in their applications.

Returns:

  • (String, nil)

See Also:



726
727
728
 
# File 'sagemaker/cfn_model_card.rb', line 726

def caveats_and_recommendations
  @caveats_and_recommendations
end

#custom_details ⇒ AWSCDK::IResolvable, ... (readonly)

Any additional information to document about the model.

Returns:

See Also:



731
732
733
 
# File 'sagemaker/cfn_model_card.rb', line 731

def custom_details
  @custom_details
end

#ethical_considerations ⇒ String? (readonly)

Any ethical considerations documented by the model card author.

Returns:

  • (String, nil)

See Also:



736
737
738
 
# File 'sagemaker/cfn_model_card.rb', line 736

def ethical_considerations
  @ethical_considerations
end

Class Method Details

.jsii_properties ⇒ Object 



738
739
740
741
742
743
744
 
# File 'sagemaker/cfn_model_card.rb', line 738

def self.jsii_properties
  {
    :caveats_and_recommendations => "caveatsAndRecommendations",
    :custom_details => "customDetails",
    :ethical_considerations => "ethicalConsiderations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



746
747
748
749
750
751
752
753
754
 
# File 'sagemaker/cfn_model_card.rb', line 746

def to_jsii
  result = {}
  result.merge!({
    "caveatsAndRecommendations" => @caveats_and_recommendations,
    "customDetails" => @custom_details,
    "ethicalConsiderations" => @ethical_considerations,
  })
  result.compact
end