#[non_exhaustive]pub struct EvaluationBuilder { /* private fields */ }
Expand description
A builder for Evaluation
.
Implementations§
Source§impl EvaluationBuilder
impl EvaluationBuilder
Sourcepub fn evaluation_id(self, input: impl Into<String>) -> Self
pub fn evaluation_id(self, input: impl Into<String>) -> Self
The ID that is assigned to the Evaluation
at creation.
Sourcepub fn set_evaluation_id(self, input: Option<String>) -> Self
pub fn set_evaluation_id(self, input: Option<String>) -> Self
The ID that is assigned to the Evaluation
at creation.
Sourcepub fn get_evaluation_id(&self) -> &Option<String>
pub fn get_evaluation_id(&self) -> &Option<String>
The ID that is assigned to the Evaluation
at creation.
Sourcepub fn ml_model_id(self, input: impl Into<String>) -> Self
pub fn ml_model_id(self, input: impl Into<String>) -> Self
The ID of the MLModel
that is the focus of the evaluation.
Sourcepub fn set_ml_model_id(self, input: Option<String>) -> Self
pub fn set_ml_model_id(self, input: Option<String>) -> Self
The ID of the MLModel
that is the focus of the evaluation.
Sourcepub fn get_ml_model_id(&self) -> &Option<String>
pub fn get_ml_model_id(&self) -> &Option<String>
The ID of the MLModel
that is the focus of the evaluation.
Sourcepub fn evaluation_data_source_id(self, input: impl Into<String>) -> Self
pub fn evaluation_data_source_id(self, input: impl Into<String>) -> Self
The ID of the DataSource
that is used to evaluate the MLModel
.
Sourcepub fn set_evaluation_data_source_id(self, input: Option<String>) -> Self
pub fn set_evaluation_data_source_id(self, input: Option<String>) -> Self
The ID of the DataSource
that is used to evaluate the MLModel
.
Sourcepub fn get_evaluation_data_source_id(&self) -> &Option<String>
pub fn get_evaluation_data_source_id(&self) -> &Option<String>
The ID of the DataSource
that is used to evaluate the MLModel
.
Sourcepub fn input_data_location_s3(self, input: impl Into<String>) -> Self
pub fn input_data_location_s3(self, input: impl Into<String>) -> Self
The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
Sourcepub fn set_input_data_location_s3(self, input: Option<String>) -> Self
pub fn set_input_data_location_s3(self, input: Option<String>) -> Self
The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
Sourcepub fn get_input_data_location_s3(&self) -> &Option<String>
pub fn get_input_data_location_s3(&self) -> &Option<String>
The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
Sourcepub fn created_by_iam_user(self, input: impl Into<String>) -> Self
pub fn created_by_iam_user(self, input: impl Into<String>) -> Self
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Sourcepub fn set_created_by_iam_user(self, input: Option<String>) -> Self
pub fn set_created_by_iam_user(self, input: Option<String>) -> Self
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Sourcepub fn get_created_by_iam_user(&self) -> &Option<String>
pub fn get_created_by_iam_user(&self) -> &Option<String>
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time that the Evaluation
was created. The time is expressed in epoch time.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time that the Evaluation
was created. The time is expressed in epoch time.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time that the Evaluation
was created. The time is expressed in epoch time.
Sourcepub fn last_updated_at(self, input: DateTime) -> Self
pub fn last_updated_at(self, input: DateTime) -> Self
The time of the most recent edit to the Evaluation
. The time is expressed in epoch time.
Sourcepub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
The time of the most recent edit to the Evaluation
. The time is expressed in epoch time.
Sourcepub fn get_last_updated_at(&self) -> &Option<DateTime>
pub fn get_last_updated_at(&self) -> &Option<DateTime>
The time of the most recent edit to the Evaluation
. The time is expressed in epoch time.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A user-supplied name or description of the Evaluation
.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A user-supplied name or description of the Evaluation
.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
A user-supplied name or description of the Evaluation
.
Sourcepub fn status(self, input: EntityStatus) -> Self
pub fn status(self, input: EntityStatus) -> Self
The status of the evaluation. This element can have one of the following values:
-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to evaluate anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
is marked as deleted. It is not usable.
Sourcepub fn set_status(self, input: Option<EntityStatus>) -> Self
pub fn set_status(self, input: Option<EntityStatus>) -> Self
The status of the evaluation. This element can have one of the following values:
-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to evaluate anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
is marked as deleted. It is not usable.
Sourcepub fn get_status(&self) -> &Option<EntityStatus>
pub fn get_status(&self) -> &Option<EntityStatus>
The status of the evaluation. This element can have one of the following values:
-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to evaluate anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
is marked as deleted. It is not usable.
Sourcepub fn performance_metrics(self, input: PerformanceMetrics) -> Self
pub fn performance_metrics(self, input: PerformanceMetrics) -> Self
Measurements of how well the MLModel
performed, using observations referenced by the DataSource
. One of the following metrics is returned, based on the type of the MLModel
:
-
BinaryAUC: A binary
MLModel
uses the Area Under the Curve (AUC) technique to measure performance. -
RegressionRMSE: A regression
MLModel
uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. -
MulticlassAvgFScore: A multiclass
MLModel
uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
Sourcepub fn set_performance_metrics(self, input: Option<PerformanceMetrics>) -> Self
pub fn set_performance_metrics(self, input: Option<PerformanceMetrics>) -> Self
Measurements of how well the MLModel
performed, using observations referenced by the DataSource
. One of the following metrics is returned, based on the type of the MLModel
:
-
BinaryAUC: A binary
MLModel
uses the Area Under the Curve (AUC) technique to measure performance. -
RegressionRMSE: A regression
MLModel
uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. -
MulticlassAvgFScore: A multiclass
MLModel
uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
Sourcepub fn get_performance_metrics(&self) -> &Option<PerformanceMetrics>
pub fn get_performance_metrics(&self) -> &Option<PerformanceMetrics>
Measurements of how well the MLModel
performed, using observations referenced by the DataSource
. One of the following metrics is returned, based on the type of the MLModel
:
-
BinaryAUC: A binary
MLModel
uses the Area Under the Curve (AUC) technique to measure performance. -
RegressionRMSE: A regression
MLModel
uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. -
MulticlassAvgFScore: A multiclass
MLModel
uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
A description of the most recent details about evaluating the MLModel
.
Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
A description of the most recent details about evaluating the MLModel
.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
A description of the most recent details about evaluating the MLModel
.
Sourcepub fn compute_time(self, input: i64) -> Self
pub fn compute_time(self, input: i64) -> Self
Long integer type that is a 64-bit signed number.
Sourcepub fn set_compute_time(self, input: Option<i64>) -> Self
pub fn set_compute_time(self, input: Option<i64>) -> Self
Long integer type that is a 64-bit signed number.
Sourcepub fn get_compute_time(&self) -> &Option<i64>
pub fn get_compute_time(&self) -> &Option<i64>
Long integer type that is a 64-bit signed number.
Sourcepub fn finished_at(self, input: DateTime) -> Self
pub fn finished_at(self, input: DateTime) -> Self
A timestamp represented in epoch time.
Sourcepub fn set_finished_at(self, input: Option<DateTime>) -> Self
pub fn set_finished_at(self, input: Option<DateTime>) -> Self
A timestamp represented in epoch time.
Sourcepub fn get_finished_at(&self) -> &Option<DateTime>
pub fn get_finished_at(&self) -> &Option<DateTime>
A timestamp represented in epoch time.
Sourcepub fn started_at(self, input: DateTime) -> Self
pub fn started_at(self, input: DateTime) -> Self
A timestamp represented in epoch time.
Sourcepub fn set_started_at(self, input: Option<DateTime>) -> Self
pub fn set_started_at(self, input: Option<DateTime>) -> Self
A timestamp represented in epoch time.
Sourcepub fn get_started_at(&self) -> &Option<DateTime>
pub fn get_started_at(&self) -> &Option<DateTime>
A timestamp represented in epoch time.
Sourcepub fn build(self) -> Evaluation
pub fn build(self) -> Evaluation
Consumes the builder and constructs a Evaluation
.
Trait Implementations§
Source§impl Clone for EvaluationBuilder
impl Clone for EvaluationBuilder
Source§fn clone(&self) -> EvaluationBuilder
fn clone(&self) -> EvaluationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EvaluationBuilder
impl Debug for EvaluationBuilder
Source§impl Default for EvaluationBuilder
impl Default for EvaluationBuilder
Source§fn default() -> EvaluationBuilder
fn default() -> EvaluationBuilder
Source§impl PartialEq for EvaluationBuilder
impl PartialEq for EvaluationBuilder
impl StructuralPartialEq for EvaluationBuilder
Auto Trait Implementations§
impl Freeze for EvaluationBuilder
impl RefUnwindSafe for EvaluationBuilder
impl Send for EvaluationBuilder
impl Sync for EvaluationBuilder
impl Unpin for EvaluationBuilder
impl UnwindSafe for EvaluationBuilder
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);