Lf

LFBase

Bases: ABC

Abstract labelling function. Uses to annotate

Source code in src/annotation/lf.py

class LFBase(ABC):
    """
    Abstract labelling function. Uses to annotate
    """
    def __init__(self, taxonomy: TaxonomyBase):
        """
        Taxonomy containing labels to annotate the examples with.
        :param taxonomy:
        """
        self.taxonomy = taxonomy
        self.content = True

    def annotate(self, name: str, content: str) -> np.array:
        """
        Annotate an example given the file name and it's content.
        :param name: Source file name
        :param content: Content of the file (usually identifiers)
        :return:
        """
        pass

__init__(taxonomy)

Taxonomy containing labels to annotate the examples with.

Parameters:

Name	Type	Description	Default
taxonomy	TaxonomyBase		required

Source code in src/annotation/lf.py

def __init__(self, taxonomy: TaxonomyBase):
    """
    Taxonomy containing labels to annotate the examples with.
    :param taxonomy:
    """
    self.taxonomy = taxonomy
    self.content = True

annotate(name, content)

Annotate an example given the file name and it's content.

Parameters:

Name	Type	Description	Default
name	str	Source file name	required
content	str	Content of the file (usually identifiers)	required

Returns:

Type	Description
array

Source code in src/annotation/lf.py

def annotate(self, name: str, content: str) -> np.array:
    """
    Annotate an example given the file name and it's content.
    :param name: Source file name
    :param content: Content of the file (usually identifiers)
    :return:
    """
    pass