Class: Aws::Personalize::Types::SolutionVersion
- Inherits:
-
Struct
- Object
- Struct
- Aws::Personalize::Types::SolutionVersion
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-personalize/types.rb
Overview
An object that provides information about a specific version of a
- Solution][1
-
in a Custom dataset group.
[1]: docs.aws.amazon.com/personalize/latest/dg/API_Solution.html
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_date_time ⇒ Time
The date and time (in Unix time) that this version of the solution was created.
-
#dataset_group_arn ⇒ String
The Amazon Resource Name (ARN) of the dataset group providing the training data.
-
#event_type ⇒ String
The event type (for example, ‘click’ or ‘like’) that is used for training the model.
-
#failure_reason ⇒ String
If training a solution version fails, the reason for the failure.
-
#last_updated_date_time ⇒ Time
The date and time (in Unix time) that the solution was last updated.
-
#name ⇒ String
The name of the solution version.
-
#perform_auto_ml ⇒ Boolean
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration.
-
#perform_hpo ⇒ Boolean
Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
-
#recipe_arn ⇒ String
The ARN of the recipe used in the solution.
-
#solution_arn ⇒ String
The ARN of the solution.
-
#solution_config ⇒ Types::SolutionConfig
Describes the configuration properties for the solution.
-
#solution_version_arn ⇒ String
The ARN of the solution version.
-
#status ⇒ String
The status of the solution version.
-
#training_hours ⇒ Float
The time used to train the model.
-
#training_mode ⇒ String
The scope of training to be performed when creating the solution version.
-
#tuned_hpo_params ⇒ Types::TunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
Instance Attribute Details
#creation_date_time ⇒ Time
The date and time (in Unix time) that this version of the solution was created.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_arn ⇒ String
The Amazon Resource Name (ARN) of the dataset group providing the training data.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_type ⇒ String
The event type (for example, ‘click’ or ‘like’) that is used for training the model.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_reason ⇒ String
If training a solution version fails, the reason for the failure.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_time ⇒ Time
The date and time (in Unix time) that the solution was last updated.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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 |
#name ⇒ String
The name of the solution version.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_ml ⇒ Boolean
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses ‘recipeArn`.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_hpo ⇒ Boolean
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is ‘false`.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_arn ⇒ String
The ARN of the recipe used in the solution.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_arn ⇒ String
The ARN of the solution.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_config ⇒ Types::SolutionConfig
Describes the configuration properties for the solution.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_arn ⇒ String
The ARN of the solution version.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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 |
#status ⇒ String
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
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_hours ⇒ Float
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.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_mode ⇒ String
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][1
-
recipe or the [HRNN-Coldstart] recipe.
[1]: docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html [2]: docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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_params ⇒ Types::TunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 |
# File 'lib/aws-sdk-personalize/types.rb', line 5173 class SolutionVersion < Struct.new( :name, :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 |