Update doc string of BaseCandidate.__init__().

This commit is contained in:
Raphael Mitsch 2023-03-01 13:15:38 +01:00
parent a97ef65b33
commit 3da0712582

View File

@ -14,7 +14,7 @@ class BaseCandidate(abc.ABC):
def __init__( def __init__(
self, mention: str, entity_id: Union[int, str], entity_vector: List[float] self, mention: str, entity_id: Union[int, str], entity_vector: List[float]
): ):
"""Create new instance of `Candidate`. Note: has to be a sub-class, otherwise error will be raised. """Initializes properties of `BaseCandidate`.
mention (str): Mention text for this candidate. mention (str): Mention text for this candidate.
entity_id (Union[int, str]): Unique entity ID. entity_id (Union[int, str]): Unique entity ID.
entity_vector (List[float]): Entity embedding. entity_vector (List[float]): Entity embedding.