edsnlp.pipelines.core.context

context

ContextAdder

Bases: BaseComponent

Provides a generic context adder component.

PARAMETER	DESCRIPTION
nlp	The spaCy object. TYPE: Language
context	The list of extensions to add to the Doc TYPE: List[str]

Source code in edsnlp/pipelines/core/context/context.py

class ContextAdder(BaseComponent):
    """
    Provides a generic context adder component.

    Parameters
    ----------
    nlp : Language
        The spaCy object.
    context : List[str]
        The list of extensions to add to the `Doc`
    """

    def __init__(
        self,
        nlp: Language,
        context: List[str],
    ):

        self.nlp = nlp
        self.context = context
        self.set_extensions()

    def set_extensions(self):
        for col in self.context:
            if not Doc.has_extension(col):
                Doc.set_extension(col, default=None)

    def __call__(self, doc: Doc) -> Doc:
        return doc

nlp = nlp instance-attribute

context = context instance-attribute

__init__(nlp, context)

Source code in edsnlp/pipelines/core/context/context.py

def __init__(
    self,
    nlp: Language,
    context: List[str],
):

    self.nlp = nlp
    self.context = context
    self.set_extensions()

set_extensions()

Source code in edsnlp/pipelines/core/context/context.py

def set_extensions(self):
    for col in self.context:
        if not Doc.has_extension(col):
            Doc.set_extension(col, default=None)

__call__(doc)

Source code in edsnlp/pipelines/core/context/context.py

def __call__(self, doc: Doc) -> Doc:
    return doc

factory

DEFAULT_CONFIG = dict(context=['note_id']) module-attribute

create_component(nlp, name, context)

Source code in edsnlp/pipelines/core/context/factory.py

@Language.factory("eds.context", default_config=DEFAULT_CONFIG)
def create_component(
    nlp: Language,
    name: str,
    context: List[str],
):

    return ContextAdder(
        nlp,
        context=context,
    )