Struct aws_sdk_personalize::model::SolutionVersion
source · [−]#[non_exhaustive]pub struct SolutionVersion {Show 15 fields
pub solution_version_arn: Option<String>,
pub solution_arn: Option<String>,
pub perform_hpo: bool,
pub perform_auto_ml: bool,
pub recipe_arn: Option<String>,
pub event_type: Option<String>,
pub dataset_group_arn: Option<String>,
pub solution_config: Option<SolutionConfig>,
pub training_hours: Option<f64>,
pub training_mode: Option<TrainingMode>,
pub tuned_hpo_params: Option<TunedHpoParams>,
pub status: Option<String>,
pub failure_reason: Option<String>,
pub creation_date_time: Option<DateTime>,
pub last_updated_date_time: Option<DateTime>,
}
Expand description
An object that provides information about a specific version of a Solution
in a Custom dataset group.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.solution_version_arn: Option<String>
The ARN of the solution version.
solution_arn: Option<String>
The ARN of the solution.
perform_hpo: bool
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false
.
perform_auto_ml: bool
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn
.
recipe_arn: Option<String>
The ARN of the recipe used in the solution.
event_type: Option<String>
The event type (for example, 'click' or 'like') that is used for training the model.
dataset_group_arn: Option<String>
The Amazon Resource Name (ARN) of the dataset group providing the training data.
solution_config: Option<SolutionConfig>
Describes the configuration properties for the solution.
training_hours: Option<f64>
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.
training_mode: Option<TrainingMode>
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.
tuned_hpo_params: Option<TunedHpoParams>
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
status: Option<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
failure_reason: Option<String>
If training a solution version fails, the reason for the failure.
creation_date_time: Option<DateTime>
The date and time (in Unix time) that this version of the solution was created.
last_updated_date_time: Option<DateTime>
The date and time (in Unix time) that the solution was last updated.
Implementations
sourceimpl SolutionVersion
impl SolutionVersion
sourcepub fn solution_version_arn(&self) -> Option<&str>
pub fn solution_version_arn(&self) -> Option<&str>
The ARN of the solution version.
sourcepub fn solution_arn(&self) -> Option<&str>
pub fn solution_arn(&self) -> Option<&str>
The ARN of the solution.
sourcepub fn perform_hpo(&self) -> bool
pub fn perform_hpo(&self) -> bool
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false
.
sourcepub fn perform_auto_ml(&self) -> bool
pub fn perform_auto_ml(&self) -> bool
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn
.
sourcepub fn recipe_arn(&self) -> Option<&str>
pub fn recipe_arn(&self) -> Option<&str>
The ARN of the recipe used in the solution.
sourcepub fn event_type(&self) -> Option<&str>
pub fn event_type(&self) -> Option<&str>
The event type (for example, 'click' or 'like') that is used for training the model.
sourcepub fn dataset_group_arn(&self) -> Option<&str>
pub fn dataset_group_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the dataset group providing the training data.
sourcepub fn solution_config(&self) -> Option<&SolutionConfig>
pub fn solution_config(&self) -> Option<&SolutionConfig>
Describes the configuration properties for the solution.
sourcepub fn training_hours(&self) -> Option<f64>
pub fn training_hours(&self) -> Option<f64>
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.
sourcepub fn training_mode(&self) -> Option<&TrainingMode>
pub fn training_mode(&self) -> Option<&TrainingMode>
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.
sourcepub fn tuned_hpo_params(&self) -> Option<&TunedHpoParams>
pub fn tuned_hpo_params(&self) -> Option<&TunedHpoParams>
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
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
sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
If training a solution version fails, the reason for the failure.
sourcepub fn creation_date_time(&self) -> Option<&DateTime>
pub fn creation_date_time(&self) -> Option<&DateTime>
The date and time (in Unix time) that this version of the solution was created.
sourcepub fn last_updated_date_time(&self) -> Option<&DateTime>
pub fn last_updated_date_time(&self) -> Option<&DateTime>
The date and time (in Unix time) that the solution was last updated.
sourceimpl SolutionVersion
impl SolutionVersion
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture SolutionVersion
Trait Implementations
sourceimpl Clone for SolutionVersion
impl Clone for SolutionVersion
sourcefn clone(&self) -> SolutionVersion
fn clone(&self) -> SolutionVersion
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SolutionVersion
impl Debug for SolutionVersion
sourceimpl PartialEq<SolutionVersion> for SolutionVersion
impl PartialEq<SolutionVersion> for SolutionVersion
sourcefn eq(&self, other: &SolutionVersion) -> bool
fn eq(&self, other: &SolutionVersion) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SolutionVersion) -> bool
fn ne(&self, other: &SolutionVersion) -> bool
This method tests for !=
.
impl StructuralPartialEq for SolutionVersion
Auto Trait Implementations
impl RefUnwindSafe for SolutionVersion
impl Send for SolutionVersion
impl Sync for SolutionVersion
impl Unpin for SolutionVersion
impl UnwindSafe for SolutionVersion
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more