Class: AWSCDK::Sagemaker::CfnProcessingJob::ExperimentConfigProperty

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

Overview

Associates a SageMaker job as a trial component with an experiment and trial.

Specified when you call the CreateProcessingJob API.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(experiment_name: nil, run_name: nil, trial_component_display_name: nil, trial_name: nil) ⇒ ExperimentConfigProperty

Returns a new instance of ExperimentConfigProperty.

Parameters:

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

    The name of an existing experiment to associate with the trial component.

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

    The name of the experiment run to associate with the trial component.

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

    The display name for the trial component.

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

    The name of an existing trial to associate the trial component with.



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'sagemaker/cfn_processing_job.rb', line 1057

def initialize(experiment_name: nil, run_name: nil, trial_component_display_name: nil, trial_name: nil)
  @experiment_name = experiment_name
  Jsii::Type.check_type(@experiment_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "experimentName") unless @experiment_name.nil?
  @run_name = run_name
  Jsii::Type.check_type(@run_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runName") unless @run_name.nil?
  @trial_component_display_name = trial_component_display_name
  Jsii::Type.check_type(@trial_component_display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trialComponentDisplayName") unless @trial_component_display_name.nil?
  @trial_name = trial_name
  Jsii::Type.check_type(@trial_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trialName") unless @trial_name.nil?
end

Instance Attribute Details

#experiment_name ⇒ String? (readonly)

The name of an existing experiment to associate with the trial component.

Returns:

  • (String, nil)

See Also:



1072
1073
1074
 
# File 'sagemaker/cfn_processing_job.rb', line 1072

def experiment_name
  @experiment_name
end

#run_name ⇒ String? (readonly)

The name of the experiment run to associate with the trial component.

Returns:

  • (String, nil)

See Also:



1077
1078
1079
 
# File 'sagemaker/cfn_processing_job.rb', line 1077

def run_name
  @run_name
end

#trial_component_display_name ⇒ String? (readonly)

The display name for the trial component.

If this key isn't specified, the display name is the trial component name.

Returns:

  • (String, nil)

See Also:



1084
1085
1086
 
# File 'sagemaker/cfn_processing_job.rb', line 1084

def trial_component_display_name
  @trial_component_display_name
end

#trial_name ⇒ String? (readonly)

The name of an existing trial to associate the trial component with.

If not specified, a new trial is created.

Returns:

  • (String, nil)

See Also:



1091
1092
1093
 
# File 'sagemaker/cfn_processing_job.rb', line 1091

def trial_name
  @trial_name
end

Class Method Details

.jsii_properties ⇒ Object 



1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'sagemaker/cfn_processing_job.rb', line 1093

def self.jsii_properties
  {
    :experiment_name => "experimentName",
    :run_name => "runName",
    :trial_component_display_name => "trialComponentDisplayName",
    :trial_name => "trialName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'sagemaker/cfn_processing_job.rb', line 1102

def to_jsii
  result = {}
  result.merge!({
    "experimentName" => @experiment_name,
    "runName" => @run_name,
    "trialComponentDisplayName" => @trial_component_display_name,
    "trialName" => @trial_name,
  })
  result.compact
end