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.

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)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#dataset_group_arnString

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

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#event_typeString

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

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#failure_reasonString

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

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#last_updated_date_timeTime

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

Returns:

  • (Time)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  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)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#perform_hpoBoolean

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

Returns:

  • (Boolean)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#recipe_arnString

The ARN of the recipe used in the solution.

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#solution_arnString

The ARN of the solution.

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#solution_configTypes::SolutionConfig

Describes the configuration properties for the solution.



3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#solution_version_arnString

The ARN of the solution version.

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  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

Returns:

  • (String)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  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)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#training_modeString

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)


3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end

#tuned_hpo_paramsTypes::TunedHPOParams

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



3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3436

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)
  include Aws::Structure
end