Class: AWSCDK::Sagemaker::CfnModelCard::FunctionProperty

Inherits:

Jsii::Struct

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

Defined in:

sagemaker/cfn_model_card.rb

Overview

Function details.

See Also:

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

Instance Attribute Summary

• #condition ⇒ String^? readonly

  An optional description of any conditions of your objective function metric.

• #facet ⇒ String^? readonly

  The metric of the model's objective function.

• #function ⇒ String^? readonly

  The optimization direction of the model's objective function.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(condition: nil, facet: nil, function: nil) ⇒ FunctionProperty constructor

  A new instance of FunctionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(condition: nil, facet: nil, function: nil) ⇒ FunctionProperty

Returns a new instance of FunctionProperty.

Parameters:

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

  An optional description of any conditions of your objective function metric.

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

  The metric of the model's objective function.

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

  The optimization direction of the model's objective function. You must specify one of the following values:.

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

def initialize(condition: nil, facet: nil, function: nil)
  @condition = condition
  Jsii::Type.check_type(@condition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "condition") unless @condition.nil?
  @facet = facet
  Jsii::Type.check_type(@facet, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "facet") unless @facet.nil?
  @function = function
  Jsii::Type.check_type(@function, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "function") unless @function.nil?
end

Instance Attribute Details

#condition ⇒ String^? (readonly)

An optional description of any conditions of your objective function metric.

Returns:

• (String, nil)

See Also:

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

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

def condition
  @condition
end

#facet ⇒ String^? (readonly)

The metric of the model's objective function.

For example, loss or rmse . The following list shows examples of the values that you can specify for the metric:

• ACCURACY
• AUC
• LOSS
• MAE
• RMSE

Returns:

• (String, nil)

See Also:

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

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

def facet
  @facet
end

#function ⇒ String^? (readonly)

The optimization direction of the model's objective function. You must specify one of the following values:.

• Maximize
• Minimize

Returns:

• (String, nil)

See Also:

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

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

def function
  @function
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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