#[non_exhaustive]pub struct ClassifierEvaluationMetricsBuilder { /* private fields */ }
Expand description
A builder for ClassifierEvaluationMetrics
.
Implementations§
Source§impl ClassifierEvaluationMetricsBuilder
impl ClassifierEvaluationMetricsBuilder
Sourcepub fn accuracy(self, input: f64) -> Self
pub fn accuracy(self, input: f64) -> Self
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
Sourcepub fn set_accuracy(self, input: Option<f64>) -> Self
pub fn set_accuracy(self, input: Option<f64>) -> Self
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
Sourcepub fn get_accuracy(&self) -> &Option<f64>
pub fn get_accuracy(&self) -> &Option<f64>
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
Sourcepub fn precision(self, input: f64) -> Self
pub fn precision(self, input: f64) -> Self
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
Sourcepub fn set_precision(self, input: Option<f64>) -> Self
pub fn set_precision(self, input: Option<f64>) -> Self
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
Sourcepub fn get_precision(&self) -> &Option<f64>
pub fn get_precision(&self) -> &Option<f64>
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
Sourcepub fn recall(self, input: f64) -> Self
pub fn recall(self, input: f64) -> Self
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
Sourcepub fn set_recall(self, input: Option<f64>) -> Self
pub fn set_recall(self, input: Option<f64>) -> Self
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
Sourcepub fn get_recall(&self) -> &Option<f64>
pub fn get_recall(&self) -> &Option<f64>
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
Sourcepub fn f1_score(self, input: f64) -> Self
pub fn f1_score(self, input: f64) -> Self
A measure of how accurate the classifier results are for the test data. It is derived from the Precision
and Recall
values. The F1Score
is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
Sourcepub fn set_f1_score(self, input: Option<f64>) -> Self
pub fn set_f1_score(self, input: Option<f64>) -> Self
A measure of how accurate the classifier results are for the test data. It is derived from the Precision
and Recall
values. The F1Score
is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
Sourcepub fn get_f1_score(&self) -> &Option<f64>
pub fn get_f1_score(&self) -> &Option<f64>
A measure of how accurate the classifier results are for the test data. It is derived from the Precision
and Recall
values. The F1Score
is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
Sourcepub fn micro_precision(self, input: f64) -> Self
pub fn micro_precision(self, input: f64) -> Self
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
Sourcepub fn set_micro_precision(self, input: Option<f64>) -> Self
pub fn set_micro_precision(self, input: Option<f64>) -> Self
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
Sourcepub fn get_micro_precision(&self) -> &Option<f64>
pub fn get_micro_precision(&self) -> &Option<f64>
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
Sourcepub fn micro_recall(self, input: f64) -> Self
pub fn micro_recall(self, input: f64) -> Self
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
Sourcepub fn set_micro_recall(self, input: Option<f64>) -> Self
pub fn set_micro_recall(self, input: Option<f64>) -> Self
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
Sourcepub fn get_micro_recall(&self) -> &Option<f64>
pub fn get_micro_recall(&self) -> &Option<f64>
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
Sourcepub fn micro_f1_score(self, input: f64) -> Self
pub fn micro_f1_score(self, input: f64) -> Self
A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision
and Micro Recall
values. The Micro F1Score
is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
Sourcepub fn set_micro_f1_score(self, input: Option<f64>) -> Self
pub fn set_micro_f1_score(self, input: Option<f64>) -> Self
A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision
and Micro Recall
values. The Micro F1Score
is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
Sourcepub fn get_micro_f1_score(&self) -> &Option<f64>
pub fn get_micro_f1_score(&self) -> &Option<f64>
A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision
and Micro Recall
values. The Micro F1Score
is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
Sourcepub fn hamming_loss(self, input: f64) -> Self
pub fn hamming_loss(self, input: f64) -> Self
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
Sourcepub fn set_hamming_loss(self, input: Option<f64>) -> Self
pub fn set_hamming_loss(self, input: Option<f64>) -> Self
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
Sourcepub fn get_hamming_loss(&self) -> &Option<f64>
pub fn get_hamming_loss(&self) -> &Option<f64>
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
Sourcepub fn build(self) -> ClassifierEvaluationMetrics
pub fn build(self) -> ClassifierEvaluationMetrics
Consumes the builder and constructs a ClassifierEvaluationMetrics
.
Trait Implementations§
Source§impl Clone for ClassifierEvaluationMetricsBuilder
impl Clone for ClassifierEvaluationMetricsBuilder
Source§fn clone(&self) -> ClassifierEvaluationMetricsBuilder
fn clone(&self) -> ClassifierEvaluationMetricsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ClassifierEvaluationMetricsBuilder
impl Default for ClassifierEvaluationMetricsBuilder
Source§fn default() -> ClassifierEvaluationMetricsBuilder
fn default() -> ClassifierEvaluationMetricsBuilder
Source§impl PartialEq for ClassifierEvaluationMetricsBuilder
impl PartialEq for ClassifierEvaluationMetricsBuilder
Source§fn eq(&self, other: &ClassifierEvaluationMetricsBuilder) -> bool
fn eq(&self, other: &ClassifierEvaluationMetricsBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ClassifierEvaluationMetricsBuilder
Auto Trait Implementations§
impl Freeze for ClassifierEvaluationMetricsBuilder
impl RefUnwindSafe for ClassifierEvaluationMetricsBuilder
impl Send for ClassifierEvaluationMetricsBuilder
impl Sync for ClassifierEvaluationMetricsBuilder
impl Unpin for ClassifierEvaluationMetricsBuilder
impl UnwindSafe for ClassifierEvaluationMetricsBuilder
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);