#[non_exhaustive]pub struct Recommender {
pub recommender_arn: Option<String>,
pub dataset_group_arn: Option<String>,
pub name: Option<String>,
pub recipe_arn: Option<String>,
pub recommender_config: Option<RecommenderConfig>,
pub creation_date_time: Option<DateTime>,
pub last_updated_date_time: Option<DateTime>,
pub status: Option<String>,
pub failure_reason: Option<String>,
pub latest_recommender_update: Option<RecommenderUpdateSummary>,
pub model_metrics: Option<HashMap<String, f64>>,
}
Expand description
Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.
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.recommender_arn: Option<String>
The Amazon Resource Name (ARN) of the recommender.
dataset_group_arn: Option<String>
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
name: Option<String>
The name of the recommender.
recipe_arn: Option<String>
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
recommender_config: Option<RecommenderConfig>
The configuration details of the recommender.
creation_date_time: Option<DateTime>
The date and time (in Unix format) that the recommender was created.
last_updated_date_time: Option<DateTime>
The date and time (in Unix format) that the recommender was last updated.
status: Option<String>
The status of the recommender.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
failure_reason: Option<String>
If a recommender fails, the reason behind the failure.
latest_recommender_update: Option<RecommenderUpdateSummary>
Provides a summary of the latest updates to the recommender.
model_metrics: Option<HashMap<String, f64>>
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
Implementations§
Source§impl Recommender
impl Recommender
Sourcepub fn recommender_arn(&self) -> Option<&str>
pub fn recommender_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the recommender.
Sourcepub fn dataset_group_arn(&self) -> Option<&str>
pub fn dataset_group_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
Sourcepub fn recipe_arn(&self) -> Option<&str>
pub fn recipe_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
Sourcepub fn recommender_config(&self) -> Option<&RecommenderConfig>
pub fn recommender_config(&self) -> Option<&RecommenderConfig>
The configuration details of the recommender.
Sourcepub fn creation_date_time(&self) -> Option<&DateTime>
pub fn creation_date_time(&self) -> Option<&DateTime>
The date and time (in Unix format) that the recommender 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 format) that the recommender was last updated.
Sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
The status of the recommender.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
Sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
If a recommender fails, the reason behind the failure.
Sourcepub fn latest_recommender_update(&self) -> Option<&RecommenderUpdateSummary>
pub fn latest_recommender_update(&self) -> Option<&RecommenderUpdateSummary>
Provides a summary of the latest updates to the recommender.
Sourcepub fn model_metrics(&self) -> Option<&HashMap<String, f64>>
pub fn model_metrics(&self) -> Option<&HashMap<String, f64>>
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
Source§impl Recommender
impl Recommender
Sourcepub fn builder() -> RecommenderBuilder
pub fn builder() -> RecommenderBuilder
Creates a new builder-style object to manufacture Recommender
.
Trait Implementations§
Source§impl Clone for Recommender
impl Clone for Recommender
Source§fn clone(&self) -> Recommender
fn clone(&self) -> Recommender
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Recommender
impl Debug for Recommender
Source§impl PartialEq for Recommender
impl PartialEq for Recommender
impl StructuralPartialEq for Recommender
Auto Trait Implementations§
impl Freeze for Recommender
impl RefUnwindSafe for Recommender
impl Send for Recommender
impl Sync for Recommender
impl Unpin for Recommender
impl UnwindSafe for Recommender
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);