Class: AWSCDK::Sagemaker::CfnModelCard::TrainingMetricProperty

Inherits:

Jsii::Struct

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

Defined in:

sagemaker/cfn_model_card.rb

Overview

A result from a SageMaker AI training job.

See Also:

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

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the result from the SageMaker AI training job.

• #notes ⇒ String^? readonly

  Any additional notes describing the result of the training job.

• #value ⇒ Numeric readonly

  The value of a result from the SageMaker AI training job.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, value:, notes: nil) ⇒ TrainingMetricProperty constructor

  A new instance of TrainingMetricProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, value:, notes: nil) ⇒ TrainingMetricProperty

Returns a new instance of TrainingMetricProperty.

Parameters:

• name (String) —

  The name of the result from the SageMaker AI training job.

• value (Numeric) —

  The value of a result from the SageMaker AI training job.

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

  Any additional notes describing the result of the training job.

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

def initialize(name:, value:, notes: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value")
  @notes = notes
  Jsii::Type.check_type(@notes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notes") unless @notes.nil?
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the result from the SageMaker AI training job.

Returns:

• (String)

See Also:

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

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

def name
  @name
end

#notes ⇒ String^? (readonly)

Any additional notes describing the result of the training job.

Returns:

• (String, nil)

See Also:

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

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

def notes
  @notes
end

#value ⇒ Numeric (readonly)

The value of a result from the SageMaker AI training job.

Returns:

• (Numeric)

See Also:

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

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

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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