Class: AWSCDK::Sagemaker::CfnModelCard::ObjectiveFunctionProperty

Inherits:

Jsii::Struct

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

Defined in:

sagemaker/cfn_model_card.rb

Overview

The function that is optimized during model training.

See Also:

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

Instance Attribute Summary

• #function ⇒ AWSCDK::IResolvable, ... readonly

  A function object that details optimization direction, metric, and additional descriptions.

• #notes ⇒ String^? readonly

  Notes about the object function, including other considerations for possible objective functions.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(function: nil, notes: nil) ⇒ ObjectiveFunctionProperty constructor

  A new instance of ObjectiveFunctionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(function: nil, notes: nil) ⇒ ObjectiveFunctionProperty

Returns a new instance of ObjectiveFunctionProperty.

Parameters:

• function (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::FunctionProperty, nil) (defaults to: nil) —

  A function object that details optimization direction, metric, and additional descriptions.

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

  Notes about the object function, including other considerations for possible objective functions.

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

def initialize(function: nil, notes: nil)
  @function = function.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::FunctionProperty.new(**function.transform_keys(&:to_sym)) : function
  Jsii::Type.check_type(@function, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkZ1bmN0aW9uUHJvcGVydHkifV19fQ==")), "function") unless @function.nil?
  @notes = notes
  Jsii::Type.check_type(@notes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notes") unless @notes.nil?
end

Instance Attribute Details

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

A function object that details optimization direction, metric, and additional descriptions.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::FunctionProperty, nil)

See Also:

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

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

def function
  @function
end

#notes ⇒ String^? (readonly)

Notes about the object function, including other considerations for possible objective functions.

Returns:

• (String, nil)

See Also:

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

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

def notes
  @notes
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :function => "function",
    :notes => "notes",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "function" => @function,
    "notes" => @notes,
  })
  result.compact
end