A trainable pipeline component to predict morphological features and coarse-grained POS tags following the Universal Dependencies UPOS and FEATS annotation guidelines.

Assigned Attributes

Predictions are saved to Token.morph and Token.pos.

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/morphologizer.pyx

Morphologizer.__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.

The overwrite and extend settings determine how existing annotation is handled (with the example for existing annotation A=B|C=D + predicted annotation C=E|X=Y):

• overwrite=True, extend=True: overwrite values of existing features, add any new features (A=B|C=D + C=E|X=Y → A=B|C=E|X=Y)
• overwrite=True, extend=False: overwrite completely, removing any existing features (A=B|C=D + C=E|X=Y → C=E|X=Y)
• overwrite=False, extend=True: keep values of existing features, add any new features (A=B|C=D + C=E|X=Y → A=B|C=D|X=Y)
• overwrite=False, extend=False: do not modify the existing annotation if set (A=B|C=D + C=E|X=Y → A=B|C=D)

Morphologizer.__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.

Morphologizer.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.

Morphologizer.initialize method

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.

Morphologizer.predict method

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

Morphologizer.set_annotations method

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

Morphologizer.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.

Morphologizer.get_loss method

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

Morphologizer.create_optimizer method

Create an optimizer for the pipeline component.

Morphologizer.use_params methodcontextmanager

Modify the pipe’s model, to use the given parameter values. At the end of the context, the original parameters are restored.

Morphologizer.add_label method

Add a new label to the pipe. If the Morphologizer should set annotations for both pos and morph, the label should include the UPOS as the feature POS. 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.

Morphologizer.to_disk method

Serialize the pipe to disk.

Morphologizer.from_disk method

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

Morphologizer.to_bytes method

Serialize the pipe to a bytestring.

Morphologizer.from_bytes method

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

Morphologizer.labels property

The labels currently added to the component in the Universal Dependencies FEATS format. Note that even for a blank component, this will always include the internal empty label _. If POS features are used, the labels will include the coarse-grained POS as the feature POS.

Morphologizer.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 Morphologizer.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.