instancelib.labels package

Submodules

• instancelib.labels.base module
  • LabelProvider
    • LabelProvider.document_count()
    • LabelProvider.get_instances_by_label()
    • LabelProvider.get_labels()
    • LabelProvider.labelset
    • LabelProvider.len_positive
    • LabelProvider.remove_labels()
    • LabelProvider.set_labels()
  • columnar_label_viewer()
  • default_label_viewer()
• instancelib.labels.encoder module
  • DictionaryEncoder
    • DictionaryEncoder.decode_matrix()
    • DictionaryEncoder.decode_proba_matrix()
    • DictionaryEncoder.decode_vector()
    • DictionaryEncoder.encode()
    • DictionaryEncoder.encode_batch()
    • DictionaryEncoder.from_inv()
    • DictionaryEncoder.from_list()
    • DictionaryEncoder.get_label_column_index()
    • DictionaryEncoder.initialize()
    • DictionaryEncoder.labels
  • IdentityEncoder
    • IdentityEncoder.decode_matrix()
    • IdentityEncoder.decode_vector()
    • IdentityEncoder.encode()
    • IdentityEncoder.encode_batch()
  • LabelEncoder
    • LabelEncoder.decode_matrix()
    • LabelEncoder.decode_proba_matrix()
    • LabelEncoder.decode_vector()
    • LabelEncoder.encode()
    • LabelEncoder.encode_batch()
    • LabelEncoder.encode_safe()
    • LabelEncoder.get_label_column_index()
    • LabelEncoder.initialize()
    • LabelEncoder.labels
  • MultilabelDictionaryEncoder
    • MultilabelDictionaryEncoder.decode_matrix()
    • MultilabelDictionaryEncoder.decode_vector()
    • MultilabelDictionaryEncoder.encode()
  • SklearnLabelEncoder
    • SklearnLabelEncoder.decode_matrix()
    • SklearnLabelEncoder.decode_proba_matrix()
    • SklearnLabelEncoder.decode_vector()
    • SklearnLabelEncoder.encode()
    • SklearnLabelEncoder.encode_batch()
    • SklearnLabelEncoder.get_label_column_index()
    • SklearnLabelEncoder.initialize()
    • SklearnLabelEncoder.labels
  • SklearnMultiLabelEncoder
    • SklearnMultiLabelEncoder.decode_matrix()
    • SklearnMultiLabelEncoder.decode_vector()
    • SklearnMultiLabelEncoder.encode()
    • SklearnMultiLabelEncoder.encode_batch()
• instancelib.labels.memory module
  • MemoryLabelProvider
    • MemoryLabelProvider.document_count()
    • MemoryLabelProvider.from_data()
    • MemoryLabelProvider.from_provider()
    • MemoryLabelProvider.from_tuples()
    • MemoryLabelProvider.get_instances_by_label()
    • MemoryLabelProvider.get_labels()
    • MemoryLabelProvider.labelset
    • MemoryLabelProvider.remove_labels()
    • MemoryLabelProvider.rename_labels()
    • MemoryLabelProvider.set_labels()
    • MemoryLabelProvider.translate_keys()

Module contents

class instancelib.labels.LabelEncoder(*args, **kwds)

Bases: ABC, Generic[LT, LVT, LMT, PMT]

abstract decode_matrix(matrix)

Parameters:

matrix (TypeVar(LMT)) –

Return type:

Sequence[FrozenSet[TypeVar(LT)]]

abstract decode_proba_matrix(matrix)

Parameters:

matrix (TypeVar(PMT)) –

Return type:

Sequence[FrozenSet[Tuple[TypeVar(LT), float]]]

abstract decode_vector(vector)

Parameters:

vector (TypeVar(LVT)) –

Return type:

FrozenSet[TypeVar(LT)]

abstract encode(labels)

Parameters:

labels (Iterable[TypeVar(LT)]) –

Return type:

TypeVar(LVT)

abstract encode_batch(labelings)

Parameters:

labelings (Iterable[Iterable[TypeVar(LT)]]) –

Return type:

TypeVar(LMT)

encode_safe(labels)

Parameters:

labels (Iterable[TypeVar(LT)]) –

Return type:

Optional[TypeVar(LVT)]

abstract get_label_column_index(label)

Parameters:

label (TypeVar(LT)) –

Return type:

int

abstract initialize(labels)

Parameters:

labels (Iterable[TypeVar(LT)]) –

Return type:

None

abstract property labels: Sequence[LT]

class instancelib.labels.LabelProvider(*args, **kwds)

Bases: Mapping[KT, FrozenSet[LT]], ABC, Generic[KT, LT]

document_count(label)

Parameters:

label (TypeVar(LT)) –

Return type:

int

abstract get_instances_by_label(label)

Retrieve which instances are annotated with label

Parameters:

label (LT) – A Label

Returns:

The identifiers of the instance

Return type:

Set[Instance]

abstract get_labels(instance)

Return the labels that are associated with the instance

Parameters:

instance (Union[KT, Instance]) – The instance

Returns:

The labels that are associated with the instance

Return type:

Set[LT]

abstract property labelset: FrozenSet[LT]

for setting up a classifier)

Returns:

Labels of type LT

Return type:

Set[LT]

Type:

Report all possible labels (example usage

property len_positive: int

abstract remove_labels(instance, *labels)

Remove the labels from this instance

Parameters:

• instance (Union[KT, Instance]) – The instance

• *labels (LT) – The labels that should be removed from the instance

Return type:

None

abstract set_labels(instance, *labels)

Annotate the instance with the labels listed in the parameters

Parameters:

• instance (Union[KT, Instance]) – The instance

• *labels (LT) – The labels that should be associated with the instance

Return type:

None

class instancelib.labels.MemoryLabelProvider(labelset, labeldict, labeldict_inv=None)

Bases: LabelProvider[KT, LT], Generic[KT, LT]

A Memory based implementation to test and benchmark AL algorithms

Parameters:

• labelset (Iterable[TypeVar(LT)]) –

• labeldict (Dict[TypeVar(KT), Set[TypeVar(LT)]]) –

• labeldict_inv (Optional[Dict[TypeVar(LT), Set[TypeVar(KT)]]]) –

document_count(label)

Parameters:

label (TypeVar(LT)) –

Return type:

int

classmethod from_data(labelset, indices, labels)

Parameters:

• labelset (Iterable[TypeVar(LT)]) –

• indices (Sequence[TypeVar(KT)]) –

• labels (Sequence[Iterable[TypeVar(LT)]]) –

Return type:

MemoryLabelProvider[TypeVar(KT), TypeVar(LT)]

classmethod from_provider(provider, subset=[])

Parameters:

• provider (LabelProvider[TypeVar(KT), TypeVar(LT)]) –

• subset (Iterable[TypeVar(KT)]) –

Return type:

MemoryLabelProvider[TypeVar(KT), TypeVar(LT)]

classmethod from_tuples(predictions)

Parameters:

predictions (Sequence[Tuple[TypeVar(KT), FrozenSet[TypeVar(LT)]]]) –

Return type:

MemoryLabelProvider[TypeVar(KT), TypeVar(LT)]

get_instances_by_label(label)

Retrieve which instances are annotated with label

Parameters:

label (LT) – A Label

Returns:

The identifiers of the instance

Return type:

Set[Instance]

get_labels(instance)

Return the labels that are associated with the instance

Parameters:

instance (Union[KT, Instance]) – The instance

Returns:

The labels that are associated with the instance

Return type:

Set[LT]

property labelset: FrozenSet[LT]

for setting up a classifier)

Returns:

Labels of type LT

Return type:

Set[LT]

Type:

Report all possible labels (example usage

remove_labels(instance, *labels)

Remove the labels from this instance

Parameters:

• instance (Union[KT, Instance]) – The instance

• *labels (LT) – The labels that should be removed from the instance

classmethod rename_labels(provider, mapping)

Parameters:

• provider (LabelProvider[TypeVar(KT), TypeVar(_T)]) –

• mapping (Union[Mapping[TypeVar(_T), TypeVar(LT)], Callable[[TypeVar(_T)], TypeVar(LT)]]) –

Return type:

MemoryLabelProvider[TypeVar(KT), TypeVar(LT)]

set_labels(instance, *labels)

Annotate the instance with the labels listed in the parameters

Parameters:

• instance (Union[KT, Instance]) – The instance

• *labels (LT) – The labels that should be associated with the instance

classmethod translate_keys(provider, mapping)

Parameters:

• provider (LabelProvider[TypeVar(_T), TypeVar(LT)]) –

• mapping (Mapping[TypeVar(_T), TypeVar(KT)]) –

Return type:

Self