KnowledgeBase
classv2.2The KnowledgeBase object provides a method to generate Candidate
objects, which are plausible external identifiers given a certain textual mention.
Each such Candidate holds information from the relevant KB entities,
such as its frequency in text and possible aliases.
Each entity in the knowledge base also has a pretrained entity vector of a fixed size.
KnowledgeBase.__init__ method
Create the knowledge base.
| Name | Type | Description |
|---|---|---|
vocab | Vocab | A Vocab object. |
entity_vector_length | int | Length of the fixed-size entity vectors. |
| RETURNS | KnowledgeBase | The newly constructed object. |
KnowledgeBase.entity_vector_length property
The length of the fixed-size entity vectors in the knowledge base.
| Name | Type | Description |
|---|---|---|
| RETURNS | int | Length of the fixed-size entity vectors. |
KnowledgeBase.add_entity method
Add an entity to the knowledge base, specifying its corpus frequency
and entity vector, which should be of length entity_vector_length.
| Name | Type | Description |
|---|---|---|
entity | unicode | The unique entity identifier |
freq | float | The frequency of the entity in a typical corpus |
entity_vector | vector | The pretrained vector of the entity |
KnowledgeBase.set_entities method
Define the full list of entities in the knowledge base, specifying the corpus frequency and entity vector for each entity.
| Name | Type | Description |
|---|---|---|
entity_list | iterable | List of unique entity identifiers |
freq_list | iterable | List of entity frequencies |
vector_list | iterable | List of entity vectors |
KnowledgeBase.add_alias method
Add an alias or mention to the knowledge base, specifying its potential KB identifiers
and their prior probabilities. The entity identifiers should refer to entities previously
added with add_entity or set_entities.
The sum of the prior probabilities should not exceed 1.
| Name | Type | Description |
|---|---|---|
alias | unicode | The textual mention or alias |
entities | iterable | The potential entities that the alias may refer to |
probabilities | iterable | The prior probabilities of each entity |
KnowledgeBase.__len__ method
Get the total number of entities in the knowledge base.
| Name | Type | Description |
|---|---|---|
| RETURNS | int | The number of entities in the knowledge base. |
KnowledgeBase.get_entity_strings method
Get a list of all entity IDs in the knowledge base.
| Name | Type | Description |
|---|---|---|
| RETURNS | list | The list of entities in the knowledge base. |
KnowledgeBase.get_size_aliases method
Get the total number of aliases in the knowledge base.
| Name | Type | Description |
|---|---|---|
| RETURNS | int | The number of aliases in the knowledge base. |
KnowledgeBase.get_alias_strings method
Get a list of all aliases in the knowledge base.
| Name | Type | Description |
|---|---|---|
| RETURNS | list | The list of aliases in the knowledge base. |
KnowledgeBase.get_candidates method
Given a certain textual mention as input, retrieve a list of candidate entities
of type Candidate.
| Name | Type | Description |
|---|---|---|
alias | unicode | The textual mention or alias |
| RETURNS | iterable | The list of relevant Candidate objects |
KnowledgeBase.get_vector method
Given a certain entity ID, retrieve its pretrained entity vector.
| Name | Type | Description |
|---|---|---|
entity | unicode | The entity ID |
| RETURNS | vector | The entity vector |
KnowledgeBase.get_prior_prob method
Given a certain entity ID and a certain textual mention, retrieve the prior probability of the fact that the mention links to the entity ID.
| Name | Type | Description |
|---|---|---|
entity | unicode | The entity ID |
alias | unicode | The textual mention or alias |
| RETURNS | float | The prior probability of the alias referring to the entity |
KnowledgeBase.dump method
Save the current state of the knowledge base to a directory.
| Name | Type | Description |
|---|---|---|
loc | unicode / Path | A path to a directory, which will be created if it doesn’t exist. Paths may be either strings or Path-like objects. |
KnowledgeBase.load_bulk method
Restore the state of the knowledge base from a given directory. Note that the Vocab
should also be the same as the one used to create the KB.
| Name | Type | Description |
|---|---|---|
loc | unicode / Path | A path to a directory. Paths may be either strings or Path-like objects. |
| RETURNS | KnowledgeBase | The modified KnowledgeBase object. |
Candidate.__init__ method
Construct a Candidate object. Usually this constructor is not called directly,
but instead these objects are returned by the get_candidates method
of a KnowledgeBase.
| Name | Type | Description |
|---|---|---|
kb | KnowledgeBase | The knowledge base that defined this candidate. |
entity_hash | int | The hash of the entity’s KB ID. |
entity_freq | float | The entity frequency as recorded in the KB. |
alias_hash | int | The hash of the textual mention or alias. |
prior_prob | float | The prior probability of the alias referring to the entity |
| RETURNS | Candidate | The newly constructed object. |
Candidate attributes
| Name | Type | Description |
|---|---|---|
entity | int | The entity’s unique KB identifier |
entity_ | unicode | The entity’s unique KB identifier |
alias | int | The alias or textual mention |
alias_ | unicode | The alias or textual mention |
prior_prob | long | The prior probability of the alias referring to the entity |
entity_freq | long | The frequency of the entity in a typical corpus |
entity_vector | vector | The pretrained vector of the entity |