共指消解器

class,experimental

String name:corefTrainable:

用于词级共指消解的流水线组件

一个CoreferenceResolver组件将标记分组为指向同一事物的簇。这些簇以SpanGroups形式表示，并以特定前缀开头（默认为coref_clusters）。

一个CoreferenceResolver组件可以与 SpanResolver配对使用，将单个标记扩展为文本片段。

Assigned Attributes

预测结果将保存到Doc.spans中，作为SpanGroup。跨度键将是一个前缀加上指代共指簇的序列号，从零开始。

span键前缀默认为"coref_clusters"，但可以作为参数传递。

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

配置与实现

默认配置由管道组件工厂定义，描述了组件应如何配置。您可以通过nlp.add_pipe中的config参数或在训练用的config.cfg中覆盖其设置。有关架构及其参数和超参数的详细信息，请参阅模型架构文档。

设置	描述
`model`	The `Model` powering the pipeline component. Defaults to Coref. Model
`span_cluster_prefix`	The prefix for the keys for clusters saved to `doc.spans`. Defaults to `coref_clusters`. str

CoreferenceResolver.init 方法

创建一个新的管道实例。在您的应用程序中，通常会使用快捷方式，通过其字符串名称并使用nlp.add_pipe来实例化该组件。

名称	描述
`vocab`	The shared vocabulary. Vocab
`model`	The `Model` powering the pipeline component. Model
`name`	String name of the component instance. Used to add entries to the `losses` during training. str
仅关键字
`span_cluster_prefix`	The prefix for the key for saving clusters of spans. bool

CoreferenceResolver.call 方法

将管道应用于单个文档。文档会被原地修改并返回。这通常在调用nlp对象处理文本时自动完成，所有管道组件会按顺序应用于Doc对象。 __call__和pipe方法都会委托给 predict和 set_annotations方法执行。

名称	描述
`doc`	The document to process. Doc
返回值	处理后的文档。Doc

CoreferenceResolver.pipe 方法

将管道应用于文档流。这通常在调用nlp对象处理文本时自动进行，所有管道组件会按顺序应用于Doc对象。__call__和pipe都会委托给predict和set_annotations方法。

名称	描述
`stream`	A stream of documents. Iterable[Doc]
仅关键字
`batch_size`	The number of documents to buffer. Defaults to `128`. int
YIELDS	按顺序处理后的文档。Doc

CoreferenceResolver.initialize 方法

初始化组件以进行训练。get_examples应是一个返回可迭代Example对象的函数。至少需要提供一个示例。这些数据示例用于初始化组件模型，可以是完整的训练数据或代表性样本。初始化过程包括验证网络、推断缺失形状以及根据数据设置标签方案。该方法通常由Language.initialize调用。

名称	描述
`get_examples`	Function that returns gold-standard annotations in the form of `Example` objects. Must contain at least one `Example`. Callable[[], Iterable[Example]]
仅关键字
`nlp`	The current `nlp` object. Defaults to `None`. Optional[Language]

CoreferenceResolver.predict 方法

将组件的模型应用于一批Doc对象而不修改它们。聚类结果以MentionClusters列表形式返回，每个输入Doc对应一个。MentionClusters实例实际上是一个由整数对列表组成的列表，其中每个项对应一个聚类，整数对表示词符索引。

名称	描述
`docs`	The documents to predict. Iterable[Doc]
RETURNS	The predicted coreference clusters for the `docs`. List[MentionClusters]

CoreferenceResolver.set_annotations 方法

修改一批文档，将共指聚类保存在Doc.spans中。

名称	描述
`docs`	The documents to modify. Iterable[Doc]
`clusters`	The predicted coreference clusters for the `docs`. List[MentionClusters]

CoreferenceResolver.update 方法

从一批Example对象中学习。委托给predict。

名称	描述
`examples`	A batch of `Example` objects to learn from. Iterable[Example]
仅关键字
`drop`	The dropout rate. float
`sgd`	An optimizer. Will be created via `create_optimizer` if not set. Optional[Optimizer]
`losses`	Optional record of the loss during training. Updated using the component name as the key. Optional[Dict[str, float]]
RETURNS	The updated `losses` dictionary. Dict[str, float]

CoreferenceResolver.create_optimizer 方法

为管道组件创建一个优化器。

名称	描述
返回值	优化器。Optimizer

CoreferenceResolver.use_params 方法上下文管理器

修改管道的模型，以使用给定的参数值。在上下文结束时，原始参数将被恢复。

名称	描述
`params`	The parameter values to use in the model. dict

CoreferenceResolver.to_disk 方法

将管道序列化到磁盘。

名称	描述
`path`	A 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]
仅关键字
`exclude`	String names of serialization fields to exclude. Iterable[str]

CoreferenceResolver.from_disk 方法

从磁盘加载管道。就地修改对象并返回它。

名称	描述
`path`	A path to a directory. Paths may be either strings or `Path`-like objects. Union[str,Path]
仅关键字
`exclude`	String names of serialization fields to exclude. Iterable[str]
RETURNS	The modified `CoreferenceResolver` object. CoreferenceResolver

CoreferenceResolver.to_bytes 方法

将管道序列化为字节串，包括KnowledgeBase。

名称	描述
仅关键字
`exclude`	String names of serialization fields to exclude. Iterable[str]
RETURNS	The serialized form of the `CoreferenceResolver` object. bytes

CoreferenceResolver.from_bytes 方法

从字节串加载管道。原地修改对象并返回它。

名称	描述
`bytes_data`	The data to load from. bytes
仅关键字
`exclude`	String names of serialization fields to exclude. Iterable[str]
RETURNS	The `CoreferenceResolver` object. CoreferenceResolver

序列化字段

在序列化过程中，spaCy会导出多个用于恢复对象不同方面的数据字段。如果需要，您可以通过exclude参数传入字符串名称来将它们排除在序列化之外。

名称	描述
`vocab`	The shared `Vocab`.
`cfg`	The config file. You usually don’t want to exclude this.
`model`	The binary model data. You usually don’t want to exclude this.

建议编辑