Struct Metrics 

#[non_exhaustive]
pub struct Metrics {
    pub precision: f32,
    pub recall: f32,
    pub f1_score: f32,
    pub predicted_occurrences_count: i32,
    pub ground_truth_occurrences_count: i32,
    pub predicted_document_count: i32,
    pub ground_truth_document_count: i32,
    pub true_positives_count: i32,
    pub false_positives_count: i32,
    pub false_negatives_count: i32,
    pub total_documents_count: i32,
    /* private fields */
}

Evaluation metrics, either in aggregate or about a specific entity.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

precision: f32

The calculated precision.

recall: f32

The calculated recall.

f1_score: f32

The calculated f1 score.

predicted_occurrences_count: i32

The amount of occurrences in predicted documents.

ground_truth_occurrences_count: i32

The amount of occurrences in ground truth documents.

predicted_document_count: i32

The amount of documents with a predicted occurrence.

ground_truth_document_count: i32

The amount of documents with a ground truth occurrence.

true_positives_count: i32

The amount of true positives.

false_positives_count: i32

The amount of false positives.

false_negatives_count: i32

The amount of false negatives.

total_documents_count: i32

The amount of documents that had an occurrence of this label.

Implementations

impl Metrics

pub fn new() -> Self

Creates a new default instance.

pub fn set_precision<T: Into<f32>>(self, v: T) -> Self

Sets the value of precision.

Example

let x = Metrics::new().set_precision(42.0);

pub fn set_recall<T: Into<f32>>(self, v: T) -> Self

Sets the value of recall.

Example

let x = Metrics::new().set_recall(42.0);

pub fn set_f1_score<T: Into<f32>>(self, v: T) -> Self

Sets the value of f1_score.

Example

let x = Metrics::new().set_f1_score(42.0);

pub fn set_predicted_occurrences_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of predicted_occurrences_count.

Example

let x = Metrics::new().set_predicted_occurrences_count(42);

pub fn set_ground_truth_occurrences_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of ground_truth_occurrences_count.

Example

let x = Metrics::new().set_ground_truth_occurrences_count(42);

pub fn set_predicted_document_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of predicted_document_count.

Example

let x = Metrics::new().set_predicted_document_count(42);

pub fn set_ground_truth_document_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of ground_truth_document_count.

Example

let x = Metrics::new().set_ground_truth_document_count(42);

pub fn set_true_positives_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of true_positives_count.

Example

let x = Metrics::new().set_true_positives_count(42);

pub fn set_false_positives_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of false_positives_count.

Example

let x = Metrics::new().set_false_positives_count(42);

pub fn set_false_negatives_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of false_negatives_count.

Example

let x = Metrics::new().set_false_negatives_count(42);

pub fn set_total_documents_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of total_documents_count.

Example

let x = Metrics::new().set_total_documents_count(42);

Trait Implementations

impl Clone for Metrics

fn clone(&self) -> Metrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Metrics

fn default() -> Metrics

Returns the “default value” for a type.

impl Message for Metrics

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Metrics

fn eq(&self, other: &Metrics) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Metrics