Class: AWSCDK::Sagemaker::CfnModelCard::ContentProperty

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

Overview

The content of the model card.

It follows the model card json schema .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(additional_information: nil, business_details: nil, evaluation_details: nil, intended_uses: nil, model_overview: nil, model_package_details: nil, training_details: nil) ⇒ ContentProperty

Returns a new instance of ContentProperty.

Parameters:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'sagemaker/cfn_model_card.rb', line 878

def initialize(additional_information: nil, business_details: nil, evaluation_details: nil, intended_uses: nil, model_overview: nil, model_package_details: nil, training_details: nil)
  @additional_information = additional_information.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::AdditionalInformationProperty.new(**additional_information.transform_keys(&:to_sym)) : additional_information
  Jsii::Type.check_type(@additional_information, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkFkZGl0aW9uYWxJbmZvcm1hdGlvblByb3BlcnR5In1dfX0=")), "additionalInformation") unless @additional_information.nil?
  @business_details = business_details.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::BusinessDetailsProperty.new(**business_details.transform_keys(&:to_sym)) : business_details
  Jsii::Type.check_type(@business_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkJ1c2luZXNzRGV0YWlsc1Byb3BlcnR5In1dfX0=")), "businessDetails") unless @business_details.nil?
  @evaluation_details = evaluation_details
  Jsii::Type.check_type(@evaluation_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5FdmFsdWF0aW9uRGV0YWlsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "evaluationDetails") unless @evaluation_details.nil?
  @intended_uses = intended_uses.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::IntendedUsesProperty.new(**intended_uses.transform_keys(&:to_sym)) : intended_uses
  Jsii::Type.check_type(@intended_uses, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkludGVuZGVkVXNlc1Byb3BlcnR5In1dfX0=")), "intendedUses") unless @intended_uses.nil?
  @model_overview = model_overview.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::ModelOverviewProperty.new(**model_overview.transform_keys(&:to_sym)) : model_overview
  Jsii::Type.check_type(@model_overview, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLk1vZGVsT3ZlcnZpZXdQcm9wZXJ0eSJ9XX19")), "modelOverview") unless @model_overview.nil?
  @model_package_details = model_package_details.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::ModelPackageDetailsProperty.new(**model_package_details.transform_keys(&:to_sym)) : model_package_details
  Jsii::Type.check_type(@model_package_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLk1vZGVsUGFja2FnZURldGFpbHNQcm9wZXJ0eSJ9XX19")), "modelPackageDetails") unless @model_package_details.nil?
  @training_details = training_details.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::TrainingDetailsProperty.new(**training_details.transform_keys(&:to_sym)) : training_details
  Jsii::Type.check_type(@training_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLlRyYWluaW5nRGV0YWlsc1Byb3BlcnR5In1dfX0=")), "trainingDetails") unless @training_details.nil?
end

Instance Attribute Details

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

Additional information about the model.

Returns:

See Also:



899
900
901
 
# File 'sagemaker/cfn_model_card.rb', line 899

def additional_information
  @additional_information
end

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

Information about how the model supports business goals.

Returns:

See Also:



904
905
906
 
# File 'sagemaker/cfn_model_card.rb', line 904

def business_details
  @business_details
end

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

An overview about the model's evaluation.

Returns:

See Also:



909
910
911
 
# File 'sagemaker/cfn_model_card.rb', line 909

def evaluation_details
  @evaluation_details
end

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

The intended usage of the model.

Returns:

See Also:



914
915
916
 
# File 'sagemaker/cfn_model_card.rb', line 914

def intended_uses
  @intended_uses
end

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

An overview about the model.

Returns:

See Also:



919
920
921
 
# File 'sagemaker/cfn_model_card.rb', line 919

def model_overview
  @model_overview
end

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

Metadata information related to model package version.

Returns:

See Also:



924
925
926
 
# File 'sagemaker/cfn_model_card.rb', line 924

def model_package_details
  @model_package_details
end

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

An overview about model training.

Returns:

See Also:



929
930
931
 
# File 'sagemaker/cfn_model_card.rb', line 929

def training_details
  @training_details
end

Class Method Details

.jsii_properties ⇒ Object 



931
932
933
934
935
936
937
938
939
940
941
 
# File 'sagemaker/cfn_model_card.rb', line 931

def self.jsii_properties
  {
    :additional_information => "additionalInformation",
    :business_details => "businessDetails",
    :evaluation_details => "evaluationDetails",
    :intended_uses => "intendedUses",
    :model_overview => "modelOverview",
    :model_package_details => "modelPackageDetails",
    :training_details => "trainingDetails",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'sagemaker/cfn_model_card.rb', line 943

def to_jsii
  result = {}
  result.merge!({
    "additionalInformation" => @additional_information,
    "businessDetails" => @business_details,
    "evaluationDetails" => @evaluation_details,
    "intendedUses" => @intended_uses,
    "modelOverview" => @model_overview,
    "modelPackageDetails" => @model_package_details,
    "trainingDetails" => @training_details,
  })
  result.compact
end