Class: AWSCDK::Sagemaker::CfnModelCard::TrainingJobDetailsProperty

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

Overview

The overview of a training job.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hyper_parameters: nil, training_arn: nil, training_datasets: nil, training_environment: nil, training_metrics: nil, user_provided_hyper_parameters: nil, user_provided_training_metrics: nil) ⇒ TrainingJobDetailsProperty

Returns a new instance of TrainingJobDetailsProperty.

Parameters:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'sagemaker/cfn_model_card.rb', line 1946

def initialize(hyper_parameters: nil, training_arn: nil, training_datasets: nil, training_environment: nil, training_metrics: nil, user_provided_hyper_parameters: nil, user_provided_training_metrics: nil)
  @hyper_parameters = hyper_parameters
  Jsii::Type.check_type(@hyper_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5UcmFpbmluZ0h5cGVyUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "hyperParameters") unless @hyper_parameters.nil?
  @training_arn = training_arn
  Jsii::Type.check_type(@training_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trainingArn") unless @training_arn.nil?
  @training_datasets = training_datasets
  Jsii::Type.check_type(@training_datasets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "trainingDatasets") unless @training_datasets.nil?
  @training_environment = training_environment.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::TrainingEnvironmentProperty.new(**training_environment.transform_keys(&:to_sym)) : training_environment
  Jsii::Type.check_type(@training_environment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLlRyYWluaW5nRW52aXJvbm1lbnRQcm9wZXJ0eSJ9XX19")), "trainingEnvironment") unless @training_environment.nil?
  @training_metrics = training_metrics
  Jsii::Type.check_type(@training_metrics, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5UcmFpbmluZ01ldHJpY1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "trainingMetrics") unless @training_metrics.nil?
  @user_provided_hyper_parameters = user_provided_hyper_parameters
  Jsii::Type.check_type(@user_provided_hyper_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5UcmFpbmluZ0h5cGVyUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "userProvidedHyperParameters") unless @user_provided_hyper_parameters.nil?
  @user_provided_training_metrics = user_provided_training_metrics
  Jsii::Type.check_type(@user_provided_training_metrics, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5UcmFpbmluZ01ldHJpY1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "userProvidedTrainingMetrics") unless @user_provided_training_metrics.nil?
end

Instance Attribute Details

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

The hyper parameters used in the training job.

Returns:

See Also:



1967
1968
1969
 
# File 'sagemaker/cfn_model_card.rb', line 1967

def hyper_parameters
  @hyper_parameters
end

#training_arn ⇒ String? (readonly)

The SageMaker AI training job Amazon Resource Name (ARN).

Returns:

  • (String, nil)

See Also:



1972
1973
1974
 
# File 'sagemaker/cfn_model_card.rb', line 1972

def training_arn
  @training_arn
end

#training_datasets ⇒ Array<String>? (readonly)

The location of the datasets used to train the model.

Returns:

  • (Array<String>, nil)

See Also:



1977
1978
1979
 
# File 'sagemaker/cfn_model_card.rb', line 1977

def training_datasets
  @training_datasets
end

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

The SageMaker AI training job image URI.

Returns:

See Also:



1982
1983
1984
 
# File 'sagemaker/cfn_model_card.rb', line 1982

def training_environment
  @training_environment
end

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

The SageMaker AI training job results.

Returns:

See Also:



1987
1988
1989
 
# File 'sagemaker/cfn_model_card.rb', line 1987

def training_metrics
  @training_metrics
end

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

Additional hyper parameters that you've specified when training the model.

Returns:

See Also:



1992
1993
1994
 
# File 'sagemaker/cfn_model_card.rb', line 1992

def user_provided_hyper_parameters
  @user_provided_hyper_parameters
end

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

Custom training job results.

Returns:

See Also:



1997
1998
1999
 
# File 'sagemaker/cfn_model_card.rb', line 1997

def user_provided_training_metrics
  @user_provided_training_metrics
end

Class Method Details

.jsii_properties ⇒ Object 



1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'sagemaker/cfn_model_card.rb', line 1999

def self.jsii_properties
  {
    :hyper_parameters => "hyperParameters",
    :training_arn => "trainingArn",
    :training_datasets => "trainingDatasets",
    :training_environment => "trainingEnvironment",
    :training_metrics => "trainingMetrics",
    :user_provided_hyper_parameters => "userProvidedHyperParameters",
    :user_provided_training_metrics => "userProvidedTrainingMetrics",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'sagemaker/cfn_model_card.rb', line 2011

def to_jsii
  result = {}
  result.merge!({
    "hyperParameters" => @hyper_parameters,
    "trainingArn" => @training_arn,
    "trainingDatasets" => @training_datasets,
    "trainingEnvironment" => @training_environment,
    "trainingMetrics" => @training_metrics,
    "userProvidedHyperParameters" => @user_provided_hyper_parameters,
    "userProvidedTrainingMetrics" => @user_provided_training_metrics,
  })
  result.compact
end