arekit 0.23.1__py3-none-any.whl → 0.25.0__py3-none-any.whl

arekit/contrib/source/rusentiframes/collection.py

@@ -1,157 +0,0 @@
-import json
-
-from arekit.common.labels.str_fmt import StringLabelsFormatter
-from arekit.contrib.source.rusentiframes.effect import FrameEffect
-from arekit.contrib.source.rusentiframes.io_utils import RuSentiFramesIOUtils
-from arekit.contrib.source.rusentiframes.types import RuSentiFramesVersions
-from arekit.contrib.source.rusentiframes.labels_fmt import RuSentiFramesLabelsFormatter, \
-    RuSentiFramesEffectLabelsFormatter
-from arekit.contrib.source.rusentiframes.polarity import RuSentiFramesFramePolarity
-from arekit.contrib.source.rusentiframes.role import FrameRole
-from arekit.contrib.source.rusentiframes.state import FrameState
-
-
-class RuSentiFramesCollection(object):
-
-    __frames_key = "frames"
-    __polarity_key = "polarity"
-    __state_key = "state"
-    __effect_key = "effect"
-    __variants_key = "variants"
-
-    def __init__(self, data, labels_fmt, effect_labels_fmt, lowercase_variants=True):
-        """ data: dict
-                Has the following structure of the frame contents:
-                {
-                    "frame_id": [ ... variants string list ... ]
-                    ...
-                }
-            lowercase_variants: bool
-                If 'True', forcely treat frame-variants as case-insensitive (lowercased)
-                or avoiding lowercasing operation in case of 'False'.
-        """
-        assert(isinstance(data, dict))
-        assert(isinstance(labels_fmt, StringLabelsFormatter))
-        assert(isinstance(effect_labels_fmt, StringLabelsFormatter))
-        self.__labels_fmt = labels_fmt
-        self.__effect_labels_fmt = effect_labels_fmt
-        self.__data = data
-
-        if lowercase_variants:
-            for frame_id, frame in self.__data.items():
-                frame[self.__variants_key] = [variant.lower() for variant in frame[self.__variants_key]]
-
-    # region classmethods
-
-    @classmethod
-    def read(cls, version, labels_fmt, effect_labels_fmt):
-        assert(isinstance(version, RuSentiFramesVersions))
-        assert(isinstance(labels_fmt, RuSentiFramesLabelsFormatter))
-        assert(isinstance(effect_labels_fmt, RuSentiFramesEffectLabelsFormatter))
-
-        return RuSentiFramesIOUtils.read_from_zip(
-            inner_path=RuSentiFramesIOUtils.get_collection_filepath(),
-            process_func=lambda input_file: cls.__from_json(
-                input_file=input_file,
-                labels_fmt=labels_fmt,
-                effect_labels_fmt=effect_labels_fmt),
-            version=version)
-
-    @classmethod
-    def __from_json(cls, input_file, labels_fmt, effect_labels_fmt):
-        data = json.load(input_file)
-        return cls(data=data,
-                   labels_fmt=labels_fmt,
-                   effect_labels_fmt=effect_labels_fmt)
-
-    # endregion
-
-    # region public 'try get' methods
-
-    def try_get_frame_polarity(self, frame_id, role_src, role_dest):
-        assert(isinstance(role_src, str))
-        assert(isinstance(role_dest, str))
-
-        if not self.__check_has_frame_polarity_key(frame_id):
-            return None
-
-        for args in self.__data[frame_id][self.__frames_key][self.__polarity_key]:
-            if args[0] == role_src and args[1] == role_dest:
-                return self.__frame_polarity_from_args(args)
-        return None
-
-    # endregion
-
-    # region public 'get' methods
-
-    def get_frame_roles(self, frame_id):
-        assert(isinstance(frame_id, str))
-        return [FrameRole(source=key, description=value)
-                for key, value in self.__data[frame_id]["roles"].items()]
-
-    def get_frame_polarities(self, frame_id):
-        assert(isinstance(frame_id, str))
-
-        if not self.__check_has_frame_polarity_key(frame_id):
-            return []
-
-        return [self.__frame_polarity_from_args(args)
-                for args in self.__data[frame_id][self.__frames_key][self.__polarity_key]]
-
-    def get_frame_states(self, frame_id):
-        assert(isinstance(frame_id, str))
-
-        if self.__state_key not in self.__data[frame_id][self.__frames_key]:
-            return []
-
-        return [FrameState(role=args[0], label=self.__labels_fmt.str_to_label(args[1]), prob=args[2])
-                for args in self.__data[frame_id][self.__frames_key][self.__state_key]]
-
-    def get_frame_titles(self, frame_id):
-        assert(isinstance(frame_id, str))
-        return self.__data[frame_id]["title"]
-
-    def get_frame_variants(self, frame_id):
-        return self.__data[frame_id][self.__variants_key]
-
-    def get_frame_values(self, frame_id):
-        assert(isinstance(frame_id, str))
-        # TODO. Not implemented yet.
-        pass
-
-    def get_frame_effects(self, frame_id):
-        assert(isinstance(frame_id, str))
-
-        if self.__effect_key not in self.__data[frame_id][self.__frames_key]:
-            return []
-
-        return [FrameEffect(role=args[0], label=self.__effect_labels_fmt.str_to_label(args[1]), prob=args[2])
-                for args in self.__data[frame_id][self.__frames_key][self.__effect_key]]
-
-    # endregion
-
-    # region public 'iter' methods
-
-    def iter_frames_ids(self):
-        for frame_id in self.__data.keys():
-            yield frame_id
-
-    def iter_frame_id_and_variants(self):
-        for id, frame in self.__data.items():
-            for variant in frame[self.__variants_key]:
-                yield id, variant
-
-    # endregion
-
-    # region private methods
-
-    def __check_has_frame_polarity_key(self, frame_id):
-        return self.__polarity_key in self.__data[frame_id][self.__frames_key]
-
-    def __frame_polarity_from_args(self, args):
-        return RuSentiFramesFramePolarity(role_src=args[0],
-                                          role_dest=args[1],
-                                          label=self.__labels_fmt.str_to_label(args[2]),
-                                          prob=args[3])
-
-    # endregion

arekit/contrib/source/rusentiframes/effect.py

@@ -1,24 +0,0 @@
-from arekit.common.labels.base import Label
-
-
-class FrameEffect(object):
-
-    def __init__(self, role, label, prob):
-        assert(isinstance(role, str))
-        assert(isinstance(label, Label))
-        assert(isinstance(prob, float))
-        self.__role = role
-        self.__label = label
-        self.__prob = prob
-
-    @property
-    def Role(self):
-        return self.__role
-
-    @property
-    def Label(self):
-        return self.__label
-
-    @property
-    def Prob(self):
-        return self.__prob

arekit/contrib/source/rusentiframes/io_utils.py

@@ -1,19 +0,0 @@
-from os import path
-
-from arekit.contrib.source.zip_utils import ZipArchiveUtils
-
-
-class RuSentiFramesIOUtils(ZipArchiveUtils):
-
-    # region internal methods
-
-    @staticmethod
-    def get_archive_filepath(version):
-        assert(isinstance(version, str))
-        return path.join(RuSentiFramesIOUtils.get_data_root(), "rusentiframes-{version}.zip".format(version=version))
-
-    @staticmethod
-    def get_collection_filepath():
-        return "frames.json"
-
-    # endregion

arekit/contrib/source/rusentiframes/labels_fmt.py

@@ -1,22 +0,0 @@
-from arekit.common.labels.base import Label
-from arekit.common.labels.str_fmt import StringLabelsFormatter
-
-
-class RuSentiFramesLabelsFormatter(StringLabelsFormatter):
-
-    def __init__(self, pos_label_type, neg_label_type):
-        assert(issubclass(pos_label_type, Label))
-        assert(issubclass(neg_label_type, Label))
-        stol = {'neg': neg_label_type, 'pos': pos_label_type}
-        super(RuSentiFramesLabelsFormatter, self).__init__(stol=stol)
-
-
-class RuSentiFramesEffectLabelsFormatter(StringLabelsFormatter):
-    """ Effect formatter utilizes '-' and '+' signs.
-    """
-
-    def __init__(self, pos_label_type, neg_label_type):
-        assert(issubclass(pos_label_type, Label))
-        assert(issubclass(neg_label_type, Label))
-        stol = {'-': neg_label_type, '+': pos_label_type}
-        super(RuSentiFramesEffectLabelsFormatter, self).__init__(stol=stol)

arekit/contrib/source/rusentiframes/polarity.py

@@ -1,35 +0,0 @@
-from arekit.common.frames.connotations.descriptor import FrameConnotationDescriptor
-from arekit.common.labels.base import Label
-
-
-class RuSentiFramesFramePolarity(FrameConnotationDescriptor):
-    """
-    Polarity description between source (Agent) towards dest (Theme)
-    The latter are related to roles of frame polarity.
-    """
-
-    def __init__(self, role_src, role_dest, label, prob):
-        assert(isinstance(role_src, str))
-        assert(isinstance(role_dest, str))
-        assert(isinstance(label, Label))
-        assert(isinstance(prob, float))
-        self.__role_src = role_src
-        self.__role_dest = role_dest
-        self.__label = label
-        self.__prob = prob
-
-    @property
-    def Source(self):
-        return self.__role_src
-
-    @property
-    def Destination(self):
-        return self.__role_dest
-
-    @property
-    def Label(self):
-        return self.__label
-
-    @property
-    def Prob(self):
-        return self.__prob

arekit/contrib/source/rusentiframes/role.py

@@ -1,15 +0,0 @@
-class FrameRole(object):
-
-    def __init__(self, source, description):
-        assert(isinstance(source, str))
-        assert(isinstance(description, str))
-        self.__source = source
-        self.__description = description
-
-    @property
-    def Source(self):
-        return self.__source
-
-    @property
-    def Description(self):
-        return self.__description

arekit/contrib/source/rusentiframes/state.py

@@ -1,24 +0,0 @@
-from arekit.common.labels.base import Label
-
-
-class FrameState(object):
-
-    def __init__(self, role, label, prob):
-        assert(isinstance(role, str))
-        assert(isinstance(label, Label))
-        assert(isinstance(prob, float))
-        self.__role = role
-        self.__label = label
-        self.__prob = prob
-
-    @property
-    def Role(self):
-        return self.__role
-
-    @property
-    def Label(self):
-        return self.__label
-
-    @property
-    def Prob(self):
-        return self.__prob

arekit/contrib/source/rusentiframes/types.py

@@ -1,42 +0,0 @@
-from enum import Enum
-
-
-class RuSentiFramesVersions(Enum):
-
-    # Papers for description:
-    # Distant Supervision for Sentiment Attitude Extraction (RANLP-2019)
-    # Nicolay Rusnachenko, Natalia Loukachevitch, Elena Tutubalina
-    # https://www.aclweb.org/anthology/R19-1118/
-    # https://github.com/nicolay-r/RuSentiFrames/tree/v1.0
-    V10 = "v1_0"
-
-    # Papers for description:
-    # Sentiment Frames for Attitude Extraction in Russian (DIALOG-2020)
-    # Natalia Loukachevitch, Nicolay Rusnachenko
-    # https://github.com/nicolay-r/RuSentiFrames/tree/v2.0
-    V20 = "v2_0"
-
-
-class RuSentiFramesVersionsService:
-
-    @staticmethod
-    def __iter_supported_types():
-        return iter(RuSentiFramesVersions)
-
-    @staticmethod
-    def get_name_by_type(version_type):
-        assert(isinstance(version_type, RuSentiFramesVersions))
-        return version_type.value
-
-    @staticmethod
-    def get_type_by_name(name):
-        for version_type in RuSentiFramesVersionsService.__iter_supported_types():
-            if version_type.value == name:
-                return version_type
-
-        raise Exception("RuSentiFrames version by name `{}` was hot found!".format(name))
-
-    @staticmethod
-    def iter_supported_names():
-        for version_type in RuSentiFramesVersionsService.__iter_supported_types():
-            yield version_type.value

arekit/contrib/source/rusentiframes/value.py

@@ -1,2 +0,0 @@
-class FrameValue(object):
-    pass

arekit/contrib/source/rusentrel/const.py

@@ -1,3 +0,0 @@
-# Defaul label formattings.
-POS_LABEL_STR = "pos"
-NEG_LABEL_STR = "neg"

arekit/contrib/source/rusentrel/entities.py

@@ -1,26 +0,0 @@
-from arekit.common.entities.collection import EntityCollection
-from arekit.common.synonyms.base import SynonymsCollection
-from arekit.contrib.source.brat.annot import BratAnnotationParser
-from arekit.contrib.source.rusentrel.io_utils import RuSentRelVersions, RuSentRelIOUtils
-
-
-class RuSentRelDocumentEntityCollection(EntityCollection):
-
-    def __init__(self, entities, value_to_group_id_func):
-        super(RuSentRelDocumentEntityCollection, self).__init__(
-            entities=entities,
-            value_to_group_id_func=value_to_group_id_func)
-
-        self._sort_entities(key=lambda entity: entity.IndexBegin)
-
-    @classmethod
-    def read_collection(cls, doc_id, synonyms, version=RuSentRelVersions.V11):
-        assert (isinstance(synonyms, SynonymsCollection))
-        assert (isinstance(doc_id, int))
-
-        return RuSentRelIOUtils.read_from_zip(
-            inner_path=RuSentRelIOUtils.get_entity_innerpath(index=doc_id, version=version),
-            process_func=lambda input_file: cls(
-                entities=BratAnnotationParser.parse_annotations(input_file)["entities"],
-                value_to_group_id_func=synonyms.get_synonym_group_index),
-            version=version)

arekit/contrib/source/rusentrel/io_utils.py

@@ -1,125 +0,0 @@
-from os import path
-
-from enum import Enum
-
-from arekit.contrib.source.zip_utils import ZipArchiveUtils
-
-
-class RuSentRelVersions(Enum):
-    """ Original collection repository: https://github.com/nicolay-r/RuSentRel
-        Paper: https://arxiv.org/abs/1808.08932
-    """
-    V11 = "v1_1"
-
-
-class RuSentRelIOUtils(ZipArchiveUtils):
-
-    TEST_FOLDER = "test"
-    TRAIN_FOLDER = "train"
-    ETALON_FOLDER = "etalon"
-
-    @staticmethod
-    def get_archive_filepath(version):
-        assert(version, str)
-        return path.join(RuSentRelIOUtils.get_data_root(), "rusentrel-{}.zip".format(version))
-
-    # region internal methods
-
-    @staticmethod
-    def get_sentiment_opin_filepath(index, version, prefix='art'):
-        root = RuSentRelIOUtils.__get_root_by_index(index, version=version, keep_etalon=True)
-        return path.join(root, "{prefix}{index}.opin.txt".format(prefix=prefix, index=index))
-
-    @staticmethod
-    def get_entity_innerpath(index, version):
-        assert(isinstance(index, int))
-        assert(isinstance(version, RuSentRelVersions))
-        inner_root = RuSentRelIOUtils.__get_root_by_index(doc_id=index, version=version)
-        return path.join(inner_root, "art{}.ann".format(index))
-
-    @staticmethod
-    def get_news_innerpath(index, version):
-        assert(isinstance(index, int))
-        assert(isinstance(version, RuSentRelVersions))
-        inner_root = RuSentRelIOUtils.__get_root_by_index(doc_id=index, version=version)
-        return path.join(inner_root, "art{}.txt".format(index))
-
-    @staticmethod
-    def get_synonyms_innerpath():
-        return "synonyms.txt"
-
-    # endregion
-
-    @staticmethod
-    def __get_root_by_index(doc_id, version, keep_etalon=False):
-        assert(RuSentRelIOUtils.__is_supported(version))
-        assert(isinstance(version, RuSentRelVersions))
-        assert(isinstance(doc_id, int))
-        other_dir = RuSentRelIOUtils.ETALON_FOLDER if keep_etalon else RuSentRelIOUtils.TEST_FOLDER
-        test_indices = set(RuSentRelIOUtils.__iter_indicies_from_dataset(version, RuSentRelIOUtils.TEST_FOLDER))
-        return other_dir if doc_id in test_indices else RuSentRelIOUtils.TRAIN_FOLDER
-
-    @staticmethod
-    def __is_supported(version):
-        assert(isinstance(version, RuSentRelVersions))
-        return version == RuSentRelVersions.V11
-
-    @staticmethod
-    def __number_from_string(s):
-        digit_chars = [chr for chr in s if chr.isdigit()]
-
-        if len(digit_chars) == 0:
-            return None
-
-        return int("".join(digit_chars))
-
-    @staticmethod
-    def __iter_indicies_from_dataset(version, folder_name):
-        assert(isinstance(folder_name, str))
-        assert(RuSentRelIOUtils.__is_supported(version))
-
-        used = set()
-
-        for filename in RuSentRelIOUtils.iter_filenames_from_zip(version):
-            if not folder_name in filename:
-                continue
-
-            index = RuSentRelIOUtils.__number_from_string(filename)
-
-            if index is None:
-                continue
-
-            if index in used:
-                continue
-
-            used.add(index)
-
-            yield index
-
-    # region public methods
-
-    @staticmethod
-    def iter_test_indices(version):
-        assert(RuSentRelIOUtils.__is_supported(version))
-        indices_iter = RuSentRelIOUtils.__iter_indicies_from_dataset(
-            version=version, folder_name="{}/".format(RuSentRelIOUtils.TEST_FOLDER))
-        for index in indices_iter:
-            yield index
-
-    @staticmethod
-    def iter_train_indices(version):
-        assert(RuSentRelIOUtils.__is_supported(version))
-        indices_iter = RuSentRelIOUtils.__iter_indicies_from_dataset(
-            version=version, folder_name="{}/".format(RuSentRelIOUtils.TRAIN_FOLDER))
-        for index in indices_iter:
-            yield index
-
-    @staticmethod
-    def iter_collection_indices(version):
-        assert(RuSentRelIOUtils.__is_supported(version))
-        for index in RuSentRelIOUtils.iter_train_indices(version):
-            yield index
-        for index in RuSentRelIOUtils.iter_test_indices(version):
-            yield index
-
-    # endregion

arekit/contrib/source/rusentrel/labels_fmt.py

@@ -1,12 +0,0 @@
-from arekit.common.labels.base import Label
-from arekit.common.labels.str_fmt import StringLabelsFormatter
-from arekit.contrib.source.rusentrel.const import NEG_LABEL_STR, POS_LABEL_STR
-
-
-class RuSentRelLabelsFormatter(StringLabelsFormatter):
-
-    def __init__(self, pos_label_type, neg_label_type):
-        assert(issubclass(pos_label_type, Label))
-        assert(issubclass(neg_label_type, Label))
-        stol = {NEG_LABEL_STR: neg_label_type, POS_LABEL_STR: pos_label_type}
-        super(RuSentRelLabelsFormatter, self).__init__(stol=stol)

arekit/contrib/source/rusentrel/news_reader.py

@@ -1,51 +0,0 @@
-from arekit.common.synonyms.base import SynonymsCollection
-from arekit.contrib.source.brat.news import BratNews
-from arekit.contrib.source.brat.sentences_reader import BratDocumentSentencesReader
-from arekit.contrib.source.rusentrel.entities import RuSentRelDocumentEntityCollection
-from arekit.contrib.source.rusentrel.io_utils import RuSentRelVersions, RuSentRelIOUtils
-
-
-class RuSentRelNewsReader(object):
-
-    # region class methods
-
-    @staticmethod
-    def hide_first_entry(line, entry, hide_with=" "):
-
-        index = line.find(entry)
-
-        if index >= 0:
-            pad = hide_with * len(entry)
-            before = line[0:index]
-            after = line[index+len(entry):]
-            line = "".join([before, pad, after])
-
-        return line
-
-    @staticmethod
-    def read_document(doc_id, synonyms, version=RuSentRelVersions.V11, target_doc_id=None):
-        assert(isinstance(synonyms, SynonymsCollection))
-        assert(isinstance(version, RuSentRelVersions))
-        assert(isinstance(target_doc_id, int) or target_doc_id is None)
-
-        def file_to_doc(input_file):
-
-            sentences = BratDocumentSentencesReader.from_file(
-                input_file=input_file,
-                entities=entities,
-                line_handler=lambda line: RuSentRelNewsReader.hide_first_entry(line, entry="{Author, Unknown}"),
-                skip_entity_func=lambda entity: entity.Value in ['author', 'unknown'])
-
-            return BratNews(doc_id=target_doc_id if target_doc_id is not None else doc_id,
-                            sentences=sentences,
-                            text_relations=[])
-
-        entities = RuSentRelDocumentEntityCollection.read_collection(
-            doc_id=doc_id,
-            synonyms=synonyms,
-            version=version)
-
-        return RuSentRelIOUtils.read_from_zip(
-            inner_path=RuSentRelIOUtils.get_news_innerpath(index=doc_id, version=version),
-            process_func=file_to_doc,
-            version=version)

arekit/contrib/source/rusentrel/opinions/collection.py

@@ -1,30 +0,0 @@
-from arekit.contrib.source.rusentrel.const import POS_LABEL_STR, NEG_LABEL_STR
-from arekit.contrib.source.rusentrel.io_utils import RuSentRelIOUtils, RuSentRelVersions
-from arekit.contrib.source.rusentrel.labels_fmt import RuSentRelLabelsFormatter
-from arekit.contrib.source.rusentrel.opinions.provider import RuSentRelOpinionCollectionProvider
-
-
-class RuSentRelOpinions:
-    """
-    Collection of sentiment opinions between entities
-    """
-
-    @staticmethod
-    def iter_from_doc(doc_id, labels_fmt, version=RuSentRelVersions.V11):
-        """ doc_id:
-            synonyms: None or SynonymsCollection
-                None corresponds to the related synonym collection from RuSentRel collection.
-            version: RuSentrelVersions enum
-        """
-        assert(isinstance(version, RuSentRelVersions))
-        assert(isinstance(labels_fmt, RuSentRelLabelsFormatter))
-        assert(labels_fmt.supports_value(POS_LABEL_STR))
-        assert(labels_fmt.supports_value(NEG_LABEL_STR))
-
-        return RuSentRelIOUtils.iter_from_zip(
-            inner_path=RuSentRelIOUtils.get_sentiment_opin_filepath(index=doc_id, version=version),
-            process_func=lambda input_file: RuSentRelOpinionCollectionProvider._iter_opinions_from_file(
-                input_file=input_file,
-                labels_formatter=labels_fmt,
-                error_on_non_supported=True),
-            version=version)

arekit/contrib/source/rusentrel/opinions/converter.py

@@ -1,40 +0,0 @@
-from arekit.common.labels.str_fmt import StringLabelsFormatter
-from arekit.common.opinions.base import Opinion
-
-
-class OpinionConverter(object):
-    """ Opinion type <-> string Converter.
-    """
-
-    @staticmethod
-    def try_from_string(line, labels_formatter):
-        assert(isinstance(line, str))
-
-        args = line.strip().split(',')
-        assert (len(args) >= 3)
-
-        source_value = args[0].strip()
-        target_value = args[1].strip()
-        str_label = args[2].strip()
-
-        if not labels_formatter.supports_value(str_label):
-            return None
-
-        return Opinion(source_value=source_value,
-                       target_value=target_value,
-                       sentiment=labels_formatter.str_to_label(str_label))
-
-    @staticmethod
-    def try_to_string(opinion, labels_formatter):
-        assert(isinstance(opinion, Opinion))
-        assert(isinstance(labels_formatter, StringLabelsFormatter))
-
-        label = opinion.Sentiment
-
-        if not labels_formatter.supports_label(label):
-            return None
-
-        return "{}, {}, {}, current".format(
-            opinion.SourceValue,
-            opinion.TargetValue,
-            labels_formatter.label_to_str(opinion.Sentiment))