Struct ClassifierMetadata

#[non_exhaustive]
pub struct ClassifierMetadata {
    pub number_of_labels: Option<i32>,
    pub number_of_trained_documents: Option<i32>,
    pub number_of_test_documents: Option<i32>,
    pub evaluation_metrics: Option<ClassifierEvaluationMetrics>,
}

Provides information about a document classifier.

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.

number_of_labels: Option<i32>

The number of labels in the input data.

number_of_trained_documents: Option<i32>

The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

number_of_test_documents: Option<i32>

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

evaluation_metrics: Option<ClassifierEvaluationMetrics>

Describes the result metrics for the test data associated with an documentation classifier.

Implementations

impl ClassifierMetadata

pub fn number_of_labels(&self) -> Option<i32>

The number of labels in the input data.

pub fn number_of_trained_documents(&self) -> Option<i32>

The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

pub fn number_of_test_documents(&self) -> Option<i32>

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

pub fn evaluation_metrics(&self) -> Option<&ClassifierEvaluationMetrics>

Describes the result metrics for the test data associated with an documentation classifier.

impl ClassifierMetadata

pub fn builder() -> ClassifierMetadataBuilder

Creates a new builder-style object to manufacture ClassifierMetadata.

Trait Implementations

impl Clone for ClassifierMetadata

fn clone(&self) -> ClassifierMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifierMetadata

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

Formats the value using the given formatter.

impl PartialEq for ClassifierMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ClassifierMetadata