2019-09-12 09:38:34 +00:00
---
title: EntityLinker
tag: class
2020-07-26 22:29:45 +00:00
source: spacy/pipeline/entity_linker.py
2019-09-12 09:38:34 +00:00
new: 2.2
2020-07-27 16:11:45 +00:00
teaser: 'Pipeline component for named entity linking and disambiguation'
api_base_class: /api/pipe
api_string_name: entity_linker
api_trainable: true
2019-09-12 09:38:34 +00:00
---
2020-08-06 21:20:13 +00:00
An `EntityLinker` component disambiguates textual mentions (tagged as named
2020-08-06 15:41:26 +00:00
entities) to unique identifiers, grounding the named entities into the "real
2020-08-06 21:20:13 +00:00
world". It requires a `KnowledgeBase` , as well as a function to generate
plausible candidates from that `KnowledgeBase` given a certain textual mention,
and a ML model to pick the right candidate, given the local context of the
mention.
2020-08-06 15:41:26 +00:00
2020-07-27 16:11:45 +00:00
## Config and implementation {#config}
2019-09-12 09:38:34 +00:00
2020-07-27 16:11:45 +00:00
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` ](/api/language#add_pipe ) or in your
[`config.cfg` for training ](/usage/training#config ). See the
[model architectures ](/api/architectures ) documentation for details on the
architectures and their arguments and hyperparameters.
2020-07-08 11:34:35 +00:00
2020-07-27 16:11:45 +00:00
> #### Example
>
> ```python
> from spacy.pipeline.entity_linker import DEFAULT_NEL_MODEL
> config = {
> "labels_discard": [],
> "incl_prior": True,
> "incl_context": True,
> "model": DEFAULT_NEL_MODEL,
2020-08-06 14:22:50 +00:00
> "kb_loader": {'@assets': 'spacy.EmptyKB.v1', 'entity_vector_length': 64},
> "get_candidates": {'@assets': 'spacy.CandidateGenerator.v1'},
2020-07-27 16:11:45 +00:00
> }
> nlp.add_pipe("entity_linker", config=config)
> ```
2020-08-06 14:40:48 +00:00
| Setting | Type | Description | Default |
| ---------------- | -------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------ |
| `labels_discard` | `Iterable[str]` | NER labels that will automatically get a "NIL" prediction. | `[]` |
| `incl_prior` | bool | Whether or not to include prior probabilities from the KB in the model. | `True` |
| `incl_context` | bool | Whether or not to include the local context in the model. | `True` |
| `model` | [`Model` ](https://thinc.ai/docs/api-model ) | The model to use. | [EntityLinker ](/api/architectures#EntityLinker ) |
| `kb_loader` | `Callable[[Vocab], KnowledgeBase]` | Function that creates a [`KnowledgeBase` ](/api/kb ) from a `Vocab` instance. | An empty KnowledgeBase with `entity_vector_length` 64. |
| `get_candidates` | `Callable[[KnowledgeBase, "Span"], Iterable[Candidate]]` | Function that generates plausible candidates for a given `Span` object. | Built-in dictionary-lookup function. |
2020-07-08 11:34:35 +00:00
```python
2020-07-26 22:29:45 +00:00
https://github.com/explosion/spaCy/blob/develop/spacy/pipeline/entity_linker.py
2020-07-08 11:34:35 +00:00
```
2019-09-12 09:38:34 +00:00
## EntityLinker.\_\_init\_\_ {#init tag="method"}
> #### Example
>
> ```python
2020-07-26 22:29:45 +00:00
> # Construction via add_pipe with default model
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
>
2020-07-26 22:29:45 +00:00
> # Construction via add_pipe with custom model
2020-08-06 14:40:48 +00:00
> config = {"model": {"@architectures": "my_el.v1"}}
> entity_linker = nlp.add_pipe("entity_linker", config=config)
>
> # Construction via add_pipe with custom KB and candidate generation
> config = {"kb_loader": {"@assets": "my_kb.v1"}, "get_candidates": {"@assets": "my_candidates.v1"},}
2020-07-26 22:29:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker", config=config)
2020-07-27 16:11:45 +00:00
>
> # Construction from class
> from spacy.pipeline import EntityLinker
> entity_linker = EntityLinker(nlp.vocab, model)
2019-09-12 09:38:34 +00:00
> ```
2020-07-08 10:14:30 +00:00
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
2020-07-26 22:29:45 +00:00
[`nlp.add_pipe` ](/api/language#add_pipe ).
2020-07-08 10:14:30 +00:00
2020-08-06 14:40:48 +00:00
Note that both the internal KB as well as the Candidate generator can be
customized by providing custom registered functions.
2020-07-31 15:02:54 +00:00
2020-08-06 14:40:48 +00:00
| Name | Type | Description |
| ---------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `vocab` | `Vocab` | The shared vocabulary. |
| `model` | `Model` | The [`Model` ](https://thinc.ai/docs/api-model ) powering the pipeline component. |
| `name` | str | String name of the component instance. Used to add entries to the `losses` during training. |
| _keyword-only_ | | |
| `kb_loader` | `Callable[[Vocab], KnowledgeBase]` | Function that creates a [`KnowledgeBase` ](/api/kb ) from a `Vocab` instance. |
| `get_candidates` | `Callable[[KnowledgeBase, "Span"], Iterable[Candidate]]` | Function that generates plausible candidates for a given `Span` object. |
| `labels_discard` | `Iterable[str]` | NER labels that will automatically get a "NIL" prediction. |
| `incl_prior` | bool | Whether or not to include prior probabilities from the KB in the model. |
| `incl_context` | bool | Whether or not to include the local context in the model. |
2019-09-12 09:38:34 +00:00
## EntityLinker.\_\_call\_\_ {#call tag="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
2019-09-12 14:11:15 +00:00
[`__call__` ](/api/entitylinker#call ) and [`pipe` ](/api/entitylinker#pipe )
delegate to the [`predict` ](/api/entitylinker#predict ) and
[`set_annotations` ](/api/entitylinker#set_annotations ) methods.
2019-09-12 09:38:34 +00:00
> #### Example
>
> ```python
2019-09-12 14:11:15 +00:00
> doc = nlp("This is a sentence.")
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> # This usually happens under the hood
> processed = entity_linker(doc)
> ```
| Name | Type | Description |
| ----------- | ----- | ------------------------ |
| `doc` | `Doc` | The document to process. |
| **RETURNS** | `Doc` | The processed document. |
## EntityLinker.pipe {#pipe tag="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__` ](/api/entitylinker#call ) and
[`pipe` ](/api/entitylinker#pipe ) delegate to the
[`predict` ](/api/entitylinker#predict ) and
[`set_annotations` ](/api/entitylinker#set_annotations ) methods.
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> for doc in entity_linker.pipe(docs, batch_size=50):
> pass
> ```
2020-07-27 16:11:45 +00:00
| Name | Type | Description |
| -------------- | --------------- | ------------------------------------------------------ |
| `stream` | `Iterable[Doc]` | A stream of documents. |
| _keyword-only_ | | |
| `batch_size` | int | The number of texts to buffer. Defaults to `128` . |
| **YIELDS** | `Doc` | Processed documents in the order of the original text. |
## EntityLinker.begin_training {#begin_training tag="method"}
2020-07-29 09:36:42 +00:00
Initialize the pipe for training, using data examples if available. Returns an
2020-08-05 22:28:14 +00:00
[`Optimizer` ](https://thinc.ai/docs/api-optimizers ) object.
2020-07-27 16:11:45 +00:00
> #### Example
>
> ```python
> entity_linker = nlp.add_pipe("entity_linker", last=True)
> optimizer = entity_linker.begin_training(pipeline=nlp.pipeline)
> ```
| Name | Type | Description |
| -------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `get_examples` | `Callable[[], Iterable[Example]]` | Optional function that returns gold-standard annotations in the form of [`Example` ](/api/example ) objects. |
| _keyword-only_ | | |
| `pipeline` | `List[Tuple[str, Callable]]` | Optional list of pipeline components that this component is part of. |
| `sgd` | [`Optimizer` ](https://thinc.ai/docs/api-optimizers ) | An optional optimizer. Will be created via [`create_optimizer` ](/api/dependencyparser#create_optimizer ) if not set. |
| **RETURNS** | [`Optimizer` ](https://thinc.ai/docs/api-optimizers ) | The optimizer. |
2019-09-12 09:38:34 +00:00
## EntityLinker.predict {#predict tag="method"}
2020-08-10 11:45:22 +00:00
Apply the component's model to a batch of [`Doc` ](/api/doc ) objects, without
modifying them. Returns the KB IDs for each entity in each doc, including `NIL`
if there is no prediction.
2019-09-12 09:38:34 +00:00
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2020-07-08 11:11:54 +00:00
> kb_ids = entity_linker.predict([doc1, doc2])
2019-09-12 09:38:34 +00:00
> ```
2020-07-08 11:11:54 +00:00
| Name | Type | Description |
| ----------- | --------------- | ------------------------------------------------------------ |
| `docs` | `Iterable[Doc]` | The documents to predict. |
2020-07-27 16:11:45 +00:00
| **RETURNS** | `List[str]` | The predicted KB identifiers for the entities in the `docs` . |
2019-09-12 09:38:34 +00:00
## EntityLinker.set_annotations {#set_annotations tag="method"}
2019-09-12 14:11:15 +00:00
Modify a batch of documents, using pre-computed entity IDs for a list of named
entities.
2019-09-12 09:38:34 +00:00
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2020-07-08 11:11:54 +00:00
> kb_ids = entity_linker.predict([doc1, doc2])
> entity_linker.set_annotations([doc1, doc2], kb_ids)
2019-09-12 09:38:34 +00:00
> ```
2020-07-08 11:11:54 +00:00
| Name | Type | Description |
| -------- | --------------- | ------------------------------------------------------------------------------------------------- |
| `docs` | `Iterable[Doc]` | The documents to modify. |
2020-07-27 16:11:45 +00:00
| `kb_ids` | `List[str]` | The knowledge base identifiers for the entities in the docs, predicted by `EntityLinker.predict` . |
2019-09-12 09:38:34 +00:00
## EntityLinker.update {#update tag="method"}
2020-07-07 17:17:19 +00:00
Learn from a batch of [`Example` ](/api/example ) objects, updating both the
2019-09-12 14:11:15 +00:00
pipe's entity linking model and context encoder. Delegates to
2020-07-27 16:11:45 +00:00
[`predict` ](/api/entitylinker#predict ).
2019-09-12 09:38:34 +00:00
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> optimizer = nlp.begin_training()
2020-07-08 10:14:30 +00:00
> losses = entity_linker.update(examples, sgd=optimizer)
2019-09-12 09:38:34 +00:00
> ```
2020-07-27 16:11:45 +00:00
| Name | Type | Description |
| ----------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `examples` | `Iterable[Example]` | A batch of [`Example` ](/api/example ) objects to learn from. |
| _keyword-only_ | | |
| `drop` | float | The dropout rate. |
| `set_annotations` | bool | Whether or not to update the `Example` objects with the predictions, delegating to [`set_annotations` ](/api/textcategorizer#set_annotations ). |
| `sgd` | [`Optimizer` ](https://thinc.ai/docs/api-optimizers ) | The optimizer. |
| `losses` | `Dict[str, float]` | Optional record of the loss during training. Updated using the component name as the key. |
| **RETURNS** | `Dict[str, float]` | The updated `losses` dictionary. |
2019-09-12 09:38:34 +00:00
## EntityLinker.create_optimizer {#create_optimizer tag="method"}
Create an optimizer for the pipeline component.
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> optimizer = entity_linker.create_optimizer()
> ```
2020-07-27 16:11:45 +00:00
| Name | Type | Description |
| ----------- | --------------------------------------------------- | -------------- |
| **RETURNS** | [`Optimizer` ](https://thinc.ai/docs/api-optimizers ) | The optimizer. |
2019-09-12 09:38:34 +00:00
## EntityLinker.use_params {#use_params tag="method, contextmanager"}
2020-07-28 11:37:31 +00:00
Modify the pipe's model, to use the given parameter values. At the end of the
context, the original parameters are restored.
2019-09-12 09:38:34 +00:00
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> with entity_linker.use_params(optimizer.averages):
> entity_linker.to_disk("/best_model")
> ```
2020-07-28 11:37:31 +00:00
| Name | Type | Description |
| -------- | ---- | ----------------------------------------- |
| `params` | dict | The parameter values to use in the model. |
2019-09-12 09:38:34 +00:00
## EntityLinker.to_disk {#to_disk tag="method"}
Serialize the pipe to disk.
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> entity_linker.to_disk("/path/to/entity_linker")
> ```
2020-07-29 13:14:07 +00:00
| Name | Type | Description |
| -------------- | --------------- | --------------------------------------------------------------------------------------------------------------------- |
| `path` | str / `Path` | A path to a directory, which will be created if it doesn't exist. Paths may be either strings or `Path` -like objects. |
| _keyword-only_ | | |
| `exclude` | `Iterable[str]` | String names of [serialization fields ](#serialization-fields ) to exclude. |
2019-09-12 09:38:34 +00:00
## EntityLinker.from_disk {#from_disk tag="method"}
Load the pipe from disk. Modifies the object in place and returns it.
> #### Example
>
> ```python
2020-07-27 16:11:45 +00:00
> entity_linker = nlp.add_pipe("entity_linker")
2019-09-12 09:38:34 +00:00
> entity_linker.from_disk("/path/to/entity_linker")
> ```
2020-07-29 13:14:07 +00:00
| Name | Type | Description |
| -------------- | --------------- | -------------------------------------------------------------------------- |
| `path` | str / `Path` | A path to a directory. Paths may be either strings or `Path` -like objects. |
| _keyword-only_ | | |
| `exclude` | `Iterable[str]` | String names of [serialization fields ](#serialization-fields ) to exclude. |
| **RETURNS** | `EntityLinker` | The modified `EntityLinker` object. |
2019-09-12 09:38:34 +00:00
## Serialization fields {#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.
> #### Example
>
> ```python
> data = entity_linker.to_disk("/path", exclude=["vocab"])
> ```
| Name | Description |
| ------- | -------------------------------------------------------------- |
| `vocab` | The shared [`Vocab` ](/api/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. |
| `kb` | The knowledge base. You usually don't want to exclude this. |
