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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-personalize/types.rb

Overview

An object that provides information about a specific version of a Solution.

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.
#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 used to create 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.

Returns:

(Time)

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

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_arn ⇒ `String`

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

Returns:

(String)

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

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_type ⇒ `String`

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

Returns:

(String)

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

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_reason ⇒ `String`

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

Returns:

(String)

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

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_time ⇒ `Time`

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

Returns:

(Time)

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

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_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 'lib/aws-sdk-personalize/types.rb', line 3913

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_hpo ⇒ `Boolean`

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

Returns:

(Boolean)

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

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_arn ⇒ `String`

The ARN of the recipe used in the solution.

Returns:

(String)

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

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_arn ⇒ `String`

The ARN of the solution.

Returns:

(String)

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

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_config ⇒ `Types::SolutionConfig`

Describes the configuration properties for the solution.

Returns:

(Types::SolutionConfig)

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

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_arn ⇒ `String`

The ARN of the solution version.

Returns:

(String)

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

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

#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

Returns:

(String)

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

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_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 'lib/aws-sdk-personalize/types.rb', line 3913

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_mode ⇒ `String`

The scope of training used to create 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 training data that has changed since the creation of the last solution version. Choose `UPDATE` when you want to start recommending items added to the dataset without retraining the model.

The ‘UPDATE` option can only be used after you’ve created a solution version with the ‘FULL` option and the training solution uses the native-recipe-hrnn-coldstart.

Returns:

(String)

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

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_params ⇒ `Types::TunedHPOParams`

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

Returns:

(Types::TunedHPOParams)

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

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

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

#perform_auto_ml ⇒ Boolean

#perform_hpo ⇒ Boolean

#recipe_arn ⇒ String

#solution_arn ⇒ String

#solution_config ⇒ Types::SolutionConfig

#solution_version_arn ⇒ String

#status ⇒ String

#training_hours ⇒ Float

#training_mode ⇒ 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`

#perform_auto_ml ⇒ `Boolean`

#perform_hpo ⇒ `Boolean`

#recipe_arn ⇒ `String`

#solution_arn ⇒ `String`

#solution_config ⇒ `Types::SolutionConfig`

#solution_version_arn ⇒ `String`

#status ⇒ `String`

#training_hours ⇒ `Float`

#training_mode ⇒ `String`

#tuned_hpo_params ⇒ `Types::TunedHPOParams`