Class: AWSCDK::Sagemaker::CfnModelCard::EvaluationDetailProperty

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

Overview

The evaluation details of the model.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, datasets: nil, evaluation_job_arn: nil, evaluation_observation: nil, metadata: nil, metric_groups: nil) ⇒ EvaluationDetailProperty

Returns a new instance of EvaluationDetailProperty.

Parameters:

  • name (String) —

    The evaluation job name.

  • datasets (Array<String>, nil) (defaults to: nil) —

    The location of the datasets used to evaluate the model.

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

    The Amazon Resource Name (ARN) of the evaluation job.

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

    Any observations made during the model evaluation.

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

    Additional attributes associated with the evaluation results.

  • metric_groups (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::MetricGroupProperty>, nil) (defaults to: nil) —

    An evaluation Metric Group object.



970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'sagemaker/cfn_model_card.rb', line 970

def initialize(name:, datasets: nil, evaluation_job_arn: nil, evaluation_observation: nil, metadata: nil, metric_groups: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @datasets = datasets
  Jsii::Type.check_type(@datasets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "datasets") unless @datasets.nil?
  @evaluation_job_arn = evaluation_job_arn
  Jsii::Type.check_type(@evaluation_job_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "evaluationJobArn") unless @evaluation_job_arn.nil?
  @evaluation_observation = evaluation_observation
  Jsii::Type.check_type(@evaluation_observation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "evaluationObservation") unless @evaluation_observation.nil?
  @metadata = metadata
  Jsii::Type.check_type(@metadata, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "metadata") unless @metadata.nil?
  @metric_groups = metric_groups
  Jsii::Type.check_type(@metric_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5NZXRyaWNHcm91cFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "metricGroups") unless @metric_groups.nil?
end

Instance Attribute Details

#datasets ⇒ Array<String>? (readonly)

The location of the datasets used to evaluate the model.

Returns:

  • (Array<String>, nil)

See Also:



994
995
996
 
# File 'sagemaker/cfn_model_card.rb', line 994

def datasets
  @datasets
end

#evaluation_job_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the evaluation job.

Returns:

  • (String, nil)

See Also:



999
1000
1001
 
# File 'sagemaker/cfn_model_card.rb', line 999

def evaluation_job_arn
  @evaluation_job_arn
end

#evaluation_observation ⇒ String? (readonly)

Any observations made during the model evaluation.

Returns:

  • (String, nil)

See Also:



1004
1005
1006
 
# File 'sagemaker/cfn_model_card.rb', line 1004

def evaluation_observation
  @evaluation_observation
end

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

Additional attributes associated with the evaluation results.

Returns:

See Also:



1009
1010
1011
 
# File 'sagemaker/cfn_model_card.rb', line 1009

def metadata
  @metadata
end

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

An evaluation Metric Group object.

Returns:

See Also:



1014
1015
1016
 
# File 'sagemaker/cfn_model_card.rb', line 1014

def metric_groups
  @metric_groups
end

#name ⇒ String (readonly)

The evaluation job name.

Returns:

  • (String)

See Also:



989
990
991
 
# File 'sagemaker/cfn_model_card.rb', line 989

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'sagemaker/cfn_model_card.rb', line 1016

def self.jsii_properties
  {
    :name => "name",
    :datasets => "datasets",
    :evaluation_job_arn => "evaluationJobArn",
    :evaluation_observation => "evaluationObservation",
    :metadata => "metadata",
    :metric_groups => "metricGroups",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'sagemaker/cfn_model_card.rb', line 1027

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "datasets" => @datasets,
    "evaluationJobArn" => @evaluation_job_arn,
    "evaluationObservation" => @evaluation_observation,
    "metadata" => @metadata,
    "metricGroups" => @metric_groups,
  })
  result.compact
end