edsnlp.pipelines.ner.adicap.factory

create_component(nlp, name='eds.adicap', pattern=base_code, prefix=adicap_prefix, window=500, attr='TEXT')

Create a new component to recognize and normalize ADICAP codes in documents.

PARAMETER	DESCRIPTION
nlp	spaCy Language object. TYPE: Language
name	The name of the pipe TYPE: str DEFAULT: 'eds.adicap'
pattern	The regex pattern to use for matching ADICAP codes TYPE: Optional[Union[List[str], str]] DEFAULT: base_code
prefix	The regex pattern to use for matching the prefix before ADICAP codes TYPE: Optional[Union[List[str], str]] DEFAULT: adicap_prefix
window	Number of tokens to look for prefix. It will never go further the start of the sentence TYPE: int DEFAULT: 500
attr	Attribute to match on, eg TEXT, NORM, etc. TYPE: str DEFAULT: 'TEXT'

Source code in edsnlp/pipelines/ner/adicap/factory.py

@Language.factory(
    "eds.adicap",
    default_config=DEFAULT_CONFIG,
    assigns=["doc.ents", "doc.spans"],
)
def create_component(
    nlp: Language,
    name: str = "eds.adicap",
    pattern: Optional[Union[List[str], str]] = base_code,
    prefix: Optional[Union[List[str], str]] = adicap_prefix,
    window: int = 500,
    attr: str = "TEXT",
):
    """
    Create a new component to recognize and normalize ADICAP codes in documents.

    Parameters
    ----------
    nlp: Language
        spaCy `Language` object.
    name: str
        The name of the pipe
    pattern: Optional[Union[List[str], str]]
        The regex pattern to use for matching ADICAP codes
    prefix: Optional[Union[List[str], str]]
        The regex pattern to use for matching the prefix before ADICAP codes
    window: int
        Number of tokens to look for prefix. It will never go further the start of
        the sentence
    attr: str
        Attribute to match on, eg `TEXT`, `NORM`, etc.
    """

    return Adicap(nlp, pattern=pattern, attr=attr, prefix=prefix, window=window)