The text categorizer predicts categories over a whole document. and comes in two flavors: textcat and textcat_multilabel. When you need to predict exactly one true label per document, use the textcat which has mutually exclusive labels. If you want to perform multi-label classification and predict zero, one or more true labels per document, use the textcat_multilabel component instead. For a binary classification task, you can use textcat with two labels or textcat_multilabel with one label.

Both components are documented on this page.

Assigned Attributes

Predictions will be saved to doc.cats as a dictionary, where the key is the name of the category and the value is a score between 0 and 1 (inclusive). For textcat (exclusive categories), the scores will sum to 1, while for textcat_multilabel there is no particular guarantee about their sum. This also means that for textcat, missing values are equated to a value of 0 (i.e. False) and are counted as such towards the loss and scoring metrics. This is not the case for textcat_multilabel, where missing values in the gold standard data do not influence the loss or accuracy calculations.

Note that when assigning values to create training data, the score of each category must be 0 or 1. Using other values, for example to create a document that is a little bit in category A and a little bit in category B, is not supported.

Config and implementation

The default config is defined by the pipeline component factory and describes how the component should be configured. You can override its settings via the config argument on nlp.add_pipe or in your config.cfg for training. See the model architectures documentation for details on the architectures and their arguments and hyperparameters.

explosion/spaCy/master/spacy/pipeline/textcat.py

explosion/spaCy/master/spacy/pipeline/textcat_multilabel.py

TextCategorizer.__init__ method

Create a new pipeline instance. In your application, you would normally use a shortcut for this and instantiate the component using its string name and nlp.add_pipe.

TextCategorizer.__call__ method

Apply the pipe to one document. The document is modified in place, and returned. This usually happens under the hood when the nlp object is called on a text and all pipeline components are applied to the Doc in order. Both __call__ and pipe delegate to the predict and set_annotations methods.

TextCategorizer.pipe method

Apply the pipe to a stream of documents. This usually happens under the hood when the nlp object is called on a text and all pipeline components are applied to the Doc in order. Both __call__ and pipe delegate to the predict and set_annotations methods.

TextCategorizer.initialize methodv3.0

Initialize the component for training. get_examples should be a function that returns an iterable of Example objects. At least one example should be supplied. The data examples are used to initialize the model of the component and can either be the full training data or a representative sample. Initialization includes validating the network, inferring missing shapes and setting up the label scheme based on the data. This method is typically called by Language.initialize and lets you customize arguments it receives via the [initialize.components] block in the config.

TextCategorizer.predict method

Apply the component’s model to a batch of Doc objects without modifying them.

TextCategorizer.set_annotations method

Modify a batch of Doc objects using pre-computed scores.

TextCategorizer.update method

Learn from a batch of Example objects containing the predictions and gold-standard annotations, and update the component’s model. Delegates to predict and get_loss.

TextCategorizer.rehearse methodexperimentalv3.0

Perform a “rehearsal” update from a batch of data. Rehearsal updates teach the current model to make predictions similar to an initial model to try to address the “catastrophic forgetting” problem. This feature is experimental.

TextCategorizer.get_loss method

Find the loss and gradient of loss for the batch of documents and their predicted scores.

TextCategorizer.score methodv3.0

Score a batch of examples.

TextCategorizer.create_optimizer method

Create an optimizer for the pipeline component.

TextCategorizer.use_params methodcontextmanager

Modify the pipe’s model to use the given parameter values.

TextCategorizer.add_label method

Add a new label to the pipe. Raises an error if the output dimension is already set, or if the model has already been fully initialized. Note that you don’t have to call this method if you provide a representative data sample to the initialize method. In this case, all labels found in the sample will be automatically added to the model, and the output dimension will be inferred automatically.

TextCategorizer.to_disk method

Serialize the pipe to disk.

TextCategorizer.from_disk method

Load the pipe from disk. Modifies the object in place and returns it.

TextCategorizer.to_bytes method

Serialize the pipe to a bytestring.

TextCategorizer.from_bytes method

Load the pipe from a bytestring. Modifies the object in place and returns it.

TextCategorizer.labels property

The labels currently added to the component.

TextCategorizer.label_data propertyv3.0

The labels currently added to the component and their internal meta information. This is the data generated by init labels and used by TextCategorizer.initialize to initialize the model with a pre-defined label set.

Serialization fields

During serialization, spaCy will export several data fields used to restore different aspects of the object. If needed, you can exclude them from serialization by passing in the string names via the exclude argument.