amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.Types.ClassifierMetadata

Description

 
Synopsis

Documentation

data ClassifierMetadata Source #

Provides information about a document classifier.

See: newClassifierMetadata smart constructor.

Constructors

ClassifierMetadata' 

Fields

Instances

Instances details
FromJSON ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Generic ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Associated Types

type Rep ClassifierMetadata :: Type -> Type #

Show ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

NFData ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Methods

rnf :: ClassifierMetadata -> () #

Eq ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Hashable ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

type Rep ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

type Rep ClassifierMetadata = D1 ('MetaData "ClassifierMetadata" "Amazonka.Comprehend.Types.ClassifierMetadata" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ClassifierMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "evaluationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClassifierEvaluationMetrics)) :*: S1 ('MetaSel ('Just "numberOfLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "numberOfTestDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "numberOfTrainedDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newClassifierMetadata :: ClassifierMetadata Source #

Create a value of ClassifierMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:evaluationMetrics:ClassifierMetadata', classifierMetadata_evaluationMetrics - Describes the result metrics for the test data associated with an documentation classifier.

$sel:numberOfLabels:ClassifierMetadata', classifierMetadata_numberOfLabels - The number of labels in the input data.

$sel:numberOfTestDocuments:ClassifierMetadata', classifierMetadata_numberOfTestDocuments - 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.

$sel:numberOfTrainedDocuments:ClassifierMetadata', classifierMetadata_numberOfTrainedDocuments - 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.

classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics) Source #

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

classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int) Source #

The number of labels in the input data.

classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int) Source #

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.

classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int) Source #

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.