Class: Aws::Personalize::Types::SolutionVersion

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

An object that provides information about a specific version of a Solution in a Custom dataset group.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_timeTime

The date and time (in Unix time) that this version of the solution was created.

Returns:

  • (Time)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arnString

The Amazon Resource Name (ARN) of the dataset group providing the training data.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#event_typeString

The event type (for example, 'click' or 'like') that is used for training the model.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasonString

If training a solution version fails, the reason for the failure.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_timeTime

The date and time (in Unix time) that the solution was last updated.

Returns:

  • (Time)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#perform_auto_mlBoolean

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

Returns:

  • (Boolean)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#perform_hpoBoolean

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

Returns:

  • (Boolean)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_arnString

The ARN of the recipe used in the solution.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#solution_arnString

The ARN of the solution.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#solution_configTypes::SolutionConfig

Describes the configuration properties for the solution.



5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arnString

The ARN of the solution version.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

  • CREATE STOPPING

  • CREATE STOPPED

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#training_hoursFloat

The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

Returns:

  • (Float)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#training_modeString

The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

Returns:

  • (String)


5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#tuned_hpo_paramsTypes::TunedHPOParams

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.



5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5098

class SolutionVersion < Struct.new(
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :event_type,
  :dataset_group_arn,
  :solution_config,
  :training_hours,
  :training_mode,
  :tuned_hpo_params,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end