Pipeline

CoreferenceResolver

class,experimental
String name:corefBase class:TrainablePipeTrainable:
Pipeline component for word-level coreference resolution

A CoreferenceResolver component groups tokens into clusters that refer to the same thing. Clusters are represented as SpanGroups that start with a prefix (coref_clusters by default).

A CoreferenceResolver component can be paired with a SpanResolver to expand single tokens to spans.

Assigned Attributes

Predictions will be saved to Doc.spans as a SpanGroup. The span key will be a prefix plus a serial number referring to the coreference cluster, starting from zero.

The span key prefix defaults to "coref_clusters", but can be passed as a parameter.

LocationValue
Doc.spans[prefix + "_" + cluster_number]One coreference cluster, represented as single-token spans. Cluster numbers start from 1. SpanGroup

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.

SettingDescription
modelThe Model powering the pipeline component. Defaults to Coref. Model
span_cluster_prefixThe prefix for the keys for clusters saved to doc.spans. Defaults to coref_clusters. str

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

NameDescription
vocabThe shared vocabulary. Vocab
modelThe Model powering the pipeline component. Model
nameString name of the component instance. Used to add entries to the losses during training. str
keyword-only
span_cluster_prefixThe prefix for the key for saving clusters of spans. bool

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

NameDescription
docThe document to process. Doc

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

NameDescription
streamA stream of documents. Iterable[Doc]
keyword-only
batch_sizeThe number of documents to buffer. Defaults to 128. int

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

NameDescription
get_examplesFunction that returns gold-standard annotations in the form of Example objects. Must contain at least one Example. Callable[[], Iterable[Example]]
keyword-only
nlpThe current nlp object. Defaults to None. Optional[Language]

CoreferenceResolver.predict method

Apply the component’s model to a batch of Doc objects, without modifying them. Clusters are returned as a list of MentionClusters, one for each input Doc. A MentionClusters instance is just a list of lists of pairs of ints, where each item corresponds to a cluster, and the ints correspond to token indices.

NameDescription
docsThe documents to predict. Iterable[Doc]

CoreferenceResolver.set_annotations method

Modify a batch of documents, saving coreference clusters in Doc.spans.

NameDescription
docsThe documents to modify. Iterable[Doc]
clustersThe predicted coreference clusters for the docs. List[MentionClusters]

CoreferenceResolver.update method

Learn from a batch of Example objects. Delegates to predict.

NameDescription
examplesA batch of Example objects to learn from. Iterable[Example]
keyword-only
dropThe dropout rate. float
sgdAn optimizer. Will be created via create_optimizer if not set. Optional[Optimizer]
lossesOptional record of the loss during training. Updated using the component name as the key. Optional[Dict[str, float]]

CoreferenceResolver.create_optimizer method

Create an optimizer for the pipeline component.

NameDescription

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

NameDescription
paramsThe parameter values to use in the model. dict

CoreferenceResolver.to_disk method

Serialize the pipe to disk.

NameDescription
pathA path to a directory, which will be created if it doesn’t exist. Paths may be either strings or Path-like objects. Union[str, Path]
keyword-only
excludeString names of serialization fields to exclude. Iterable[str]

CoreferenceResolver.from_disk method

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

NameDescription
pathA path to a directory. Paths may be either strings or Path-like objects. Union[str, Path]
keyword-only
excludeString names of serialization fields to exclude. Iterable[str]

CoreferenceResolver.to_bytes method

Serialize the pipe to a bytestring, including the KnowledgeBase.

NameDescription
keyword-only
excludeString names of serialization fields to exclude. Iterable[str]

CoreferenceResolver.from_bytes method

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

NameDescription
bytes_dataThe data to load from. bytes
keyword-only
excludeString names of serialization fields to exclude. Iterable[str]

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.

NameDescription
vocabThe shared Vocab.
cfgThe config file. You usually don’t want to exclude this.
modelThe binary model data. You usually don’t want to exclude this.