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

Inherits:

Struct

Object
Struct
Aws::Personalize::Types::SolutionVersion

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

#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.
#perform_incremental_update ⇒ Boolean
Whether the solution version should perform an incremental update.
#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.
#training_type ⇒ String
Whether the solution version was created automatically or manually.
#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.

Returns:

(Time)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the solution version.

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  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.

Returns:

(Boolean)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#perform_hpo ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#perform_incremental_update ⇒ `Boolean`

Whether the solution version should perform an incremental update. When set to true, the training will process only the data that has changed since the latest training, similar to when trainingMode is set to UPDATE. This can only be used with solution versions that use the User-Personalization recipe.

Returns:

(Boolean)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_arn ⇒ `String`

The ARN of the recipe used in the solution.

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#solution_arn ⇒ `String`

The ARN of the solution.

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#solution_config ⇒ `Types::SolutionConfig`

Describes the configuration properties for the solution.

Returns:

(Types::SolutionConfig)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arn ⇒ `String`

The ARN of the solution version.

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  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

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  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.

Returns:

(Float)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#training_mode ⇒ `String`

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#training_type ⇒ `String`

Whether the solution version was created automatically or manually.

Returns:

(String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

#tuned_hpo_params ⇒ `Types::TunedHPOParams`

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

Returns:

(Types::TunedHPOParams)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 5748

class SolutionVersion < Struct.new(
  :name,
  :solution_version_arn,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_incremental_update,
  :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,
  :training_type)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_time ⇒ Time

#dataset_group_arn ⇒ String

#event_type ⇒ String

#failure_reason ⇒ String

#last_updated_date_time ⇒ Time

#name ⇒ String

#perform_auto_ml ⇒ Boolean

#perform_hpo ⇒ Boolean

#perform_incremental_update ⇒ Boolean

#recipe_arn ⇒ String

#solution_arn ⇒ String

#solution_config ⇒ Types::SolutionConfig

#solution_version_arn ⇒ String

#status ⇒ String

#training_hours ⇒ Float

#training_mode ⇒ String

#training_type ⇒ String

#tuned_hpo_params ⇒ Types::TunedHPOParams

#creation_date_time ⇒ `Time`

#dataset_group_arn ⇒ `String`

#event_type ⇒ `String`

#failure_reason ⇒ `String`

#last_updated_date_time ⇒ `Time`

#name ⇒ `String`

#perform_auto_ml ⇒ `Boolean`

#perform_hpo ⇒ `Boolean`

#perform_incremental_update ⇒ `Boolean`

#recipe_arn ⇒ `String`

#solution_arn ⇒ `String`

#solution_config ⇒ `Types::SolutionConfig`

#solution_version_arn ⇒ `String`

#status ⇒ `String`

#training_hours ⇒ `Float`

#training_mode ⇒ `String`

#training_type ⇒ `String`

#tuned_hpo_params ⇒ `Types::TunedHPOParams`