Source code for immuneML.environment.LabelConfiguration

# quality: gold
import warnings
from typing import List

from immuneML.environment.Label import Label
from immuneML.util.ParameterValidator import ParameterValidator

[docs]class LabelConfiguration: """ Class that encapsulates labels and transformers for the labels. Supports two types of labels: CLASSIFICATION and REGRESSION (as defined in LabelType class) """ def __init__(self, labels: list = None): assert labels is None or all(isinstance(label, Label) for label in labels), \ "LabelConfiguration: all labels should be instances of Label class." self._labels = { label for label in labels} if labels is not None else {}
[docs] def add_label(self, label: str, values: list = None, auxiliary_labels: list = None, positive_class=None): vals = list(values) if values else None if label in self._labels and self._labels[label] is not None and len(self._labels[label]) > 0: warnings.warn("Label " + label + " has already been set. Overriding existing values...", Warning) if positive_class is not None: if all(isinstance(val, str) for val in values) and not isinstance(positive_class, str): positive_class = str(positive_class) ParameterValidator.assert_in_valid_list(positive_class, values, Label.__name__, 'positive_class') self._labels[label] = Label(label, vals, auxiliary_labels, positive_class)
[docs] def get_labels_by_name(self): return sorted(list(self._labels.keys()))
[docs] def get_label_values(self, label: str): assert label in self._labels, label + " is not in the list of labels, so there is no information on the values." return self._labels[label].values
[docs] def get_label_count(self): return len(self._labels.keys())
[docs] def get_auxiliary_labels(self, label: str): return self._labels[label].auxiliary_label_names
[docs] def get_label_object(self, label: str) -> Label: return self._labels[label]
[docs] def get_label_objects(self) -> List[Label]: return list(self._labels.values())