chaine 3.13.1__cp313-cp313-win_amd64.whl

chaine/_core/crf.pyx

@@ -0,0 +1,271 @@
+# cython: embedsignature=True
+# cython: c_string_type=str
+# cython: c_string_encoding=utf-8
+# cython: profile=False
+# cython: language_level=2
+# distutils: language=c++
+
+cimport crfsuite_api
+from libcpp.string cimport string
+import os
+
+from chaine.logging import Logger
+from chaine.typing import Filepath, Labels, Sequence
+
+LOGGER = Logger(__name__)
+
+
+cdef class Trainer:
+    cdef crfsuite_api.Trainer _trainer
+
+    param2kwarg = {
+        "feature.minfreq": "min_freq",
+        "feature.possible_states": "all_possible_states",
+        "feature.possible_transitions": "all_possible_transitions",
+        "calibration.eta": "calibration_eta",
+        "calibration.rate": "calibration_rate",
+        "calibration.samples": "calibration_samples",
+        "calibration.candidates": "calibration_candidates",
+        "calibration.max_trials": "calibration_max_trials",
+        "type": "pa_type",
+    }
+    kwarg2param = {
+        "min_freq": "feature.minfreq",
+        "all_possible_states": "feature.possible_states",
+        "all_possible_transitions": "feature.possible_transitions",
+        "calibration_eta": "calibration.eta",
+        "calibration_rate": "calibration.rate",
+        "calibration_samples": "calibration.samples",
+        "calibration_candidates": "calibration.candidates",
+        "calibration_max_trials": "calibration.max_trials",
+        "pa_type": "type",
+    }
+    _algorithm_aliases = {
+        "lbfgs": "lbfgs",
+        "limited-memory-bfgs": "lbfgs",
+        "l2sgd": "l2sgd",
+        "sgd": "l2sgd",
+        "stochastic-gradient-descent": "l2sgd",
+        "ap": "averaged-perceptron",
+        "averaged-perceptron": "averaged-perceptron",
+        "pa": "passive-aggressive",
+        "passive-aggressive": "passive-aggressive",
+        "arow": "arow"
+    }
+    _parameter_types = {
+            "feature.minfreq": float,
+            "feature.possible_states": lambda value: bool(int(value)),
+            "feature.possible_transitions": lambda value: bool(int(value)),
+            "c1": float,
+            "c2": float,
+            "max_iterations": int,
+            "num_memories": int,
+            "epsilon": float,
+            "period": int,
+            "delta": float,
+            "linesearch": str,
+            "max_linesearch": int,
+            "calibration.eta": float,
+            "calibration.rate": float,
+            "calibration.samples": float,
+            "calibration.candidates": int,
+            "calibration.max_trials": int,
+            "type": int,
+            "c": float,
+            "error_sensitive": lambda value: bool(int(value)),
+            "averaging": lambda value: bool(int(value)),
+            "variance": float,
+            "gamma": float,
+        }
+
+    def __init__(self, algorithm: str, **kwargs):
+        self.select_algorithm(algorithm)
+        self.set_params(self.translate_params(kwargs))
+
+    def __cinit__(self):
+        self._trainer.set_handler(self, <crfsuite_api.messagefunc>self._on_message)
+        self._trainer.select("l2sgd", "crf1d")
+        self._trainer._init_trainer()
+
+    @property
+    def params(self):
+        return self._trainer.params()
+
+    def train(self, model_filepath: Filepath):
+        self._trainer.train(str(model_filepath), -1)
+
+    def _log(self, message: str):
+        LOGGER.info(message)
+
+    cdef _on_message(self, string message):
+        self._log(message)
+
+    def append(self, sequence: Sequence, labels: Labels, int group=0):
+        # no generators allowed
+        if not isinstance(sequence, list):
+            sequence = [item for item in sequence]
+        if not isinstance(labels, list):
+            # labels must be strings
+            labels = [str(label) for label in labels]
+
+        self._trainer.append(to_seq(sequence), labels, group)
+
+    def translate_params(self, kwargs: dict[str, str | int | float | bool]):
+        return {
+            self.kwarg2param.get(kwarg, kwarg): value
+            for kwarg, value in kwargs.items()
+        }
+
+    def select_algorithm(self, algorithm: str):
+        try:
+            algorithm = self._algorithm_aliases[algorithm.lower()]
+        except:
+            raise ValueError(f"{algorithm} is no available algorithm")
+        if not self._trainer.select(algorithm, "crf1d"):
+            raise ValueError(f"{algorithm} is no available algorithm")
+
+    def set_params(self, params: dict[str, str | int | float | bool]):
+        for param, value in params.items():
+            self.set_param(param, value)
+
+    def set_param(self, param: str, value: str | int | float | bool):
+        if isinstance(value, bool):
+            value = int(value)
+        self._trainer.set(param, str(value))
+
+    def get_param(self, param: str):
+        return self.cast_parameter(param, self._trainer.get(param))
+
+    def cast_parameter(self, param: str, value: str | int | float | bool):
+        if param in self._parameter_types:
+            return self._parameter_types[param](value)
+        return value
+
+
+cdef class Model:
+    cdef crfsuite_api.Tagger _tagger
+
+    def __init__(self, model_filepath: Filepath):
+        self.load(model_filepath)
+
+    @property
+    def labels(self):
+        return self._tagger.labels()
+
+    def predict_single(self, sequence: Sequence) -> list[str]:
+        self.set_sequence(sequence)
+        return self._tagger.viterbi()
+
+    def predict_proba_single(self, sequence: Sequence) -> list[dict[str, float]]:
+        self.set_sequence(sequence)
+        return [
+            {label: self.marginal(label, index) for label in self.labels}
+            for index in range(len(sequence))
+        ]
+
+    def load(self, filepath: Filepath):
+        filepath = str(filepath)
+        self.check_model(filepath)
+        if not self._tagger.open(filepath):
+            raise ValueError(f"Cannot load model file {filepath}")
+
+    def marginal(self, label: str, index: int):
+        return self._tagger.marginal(label, index)
+
+    cpdef set_sequence(self, sequence) except +:
+        self._tagger.set(to_seq(sequence))
+
+    @staticmethod
+    def check_model(filepath: str):
+        with open(filepath, "rb") as model:
+            magic = model.read(4)
+            if magic != b"lCRF":
+                raise ValueError(f"Invalid model file {filepath}")
+            model.seek(0, os.SEEK_END)
+            if model.tell() <= 48:
+                raise ValueError(f"Model file {filepath} does not have a complete header")
+
+    def dump_transitions(self, filepath: Filepath):
+        self._tagger.dump_transitions(os.open(str(filepath), os.O_WRONLY | os.O_CREAT))
+
+    def dump_states(self, filepath: Filepath):
+        self._tagger.dump_states(os.open(str(filepath), os.O_WRONLY | os.O_CREAT))
+
+cdef crfsuite_api.Item to_item(sequence) except+:
+    cdef crfsuite_api.Item c_item
+    cdef double c_value
+    cdef string c_token
+    cdef string separator
+    cdef bint is_dict, is_nested_value
+
+    separator = b":"
+    is_dict = isinstance(sequence, dict)
+    c_item = crfsuite_api.Item()
+    c_item.reserve(len(sequence))
+
+    for token in sequence:
+        if isinstance(token, unicode):
+            c_token = (<unicode>token).encode("utf8")
+        else:
+            c_token = token
+        if not is_dict:
+            c_value = 1.0
+            c_item.push_back(crfsuite_api.Attribute(c_token, c_value))
+        else:
+            value = (<dict>sequence)[token]
+            if isinstance(value, (dict, list, set)):
+                for attr in to_item(value):
+                    c_item.push_back(
+                        crfsuite_api.Attribute(c_token + separator + attr.attr, attr.value)
+                    )
+            else:
+                if isinstance(value, unicode):
+                    c_token += separator
+                    c_token += <string>(<unicode>value).encode("utf8")
+                    c_value = 1.0
+                elif isinstance(value, bytes):
+                    c_token += separator
+                    c_token += <string>value
+                    c_value = 1.0
+                else:
+                    c_value = value
+                c_item.push_back(crfsuite_api.Attribute(c_token, c_value))
+    return c_item
+
+
+cdef crfsuite_api.ItemSequence to_seq(sequence) except+:
+    cdef crfsuite_api.ItemSequence c_sequence
+
+    if isinstance(sequence, ItemSequence):
+        c_sequence = (<ItemSequence>sequence).c_sequence
+    else:
+        for s in sequence:
+            c_sequence.push_back(to_item(s))
+    return c_sequence
+
+
+cdef class ItemSequence:
+    cdef crfsuite_api.ItemSequence c_sequence
+
+    def __init__(self, sequence):
+        self.c_sequence = to_seq(sequence)
+
+    def items(self):
+        cdef crfsuite_api.Item c_item
+        cdef crfsuite_api.Attribute c_attr
+        cdef bytes token
+
+        sequence = []
+        for c_item in self.c_sequence:
+            x = {}
+            for c_attr in c_item:
+                token = <bytes>c_attr.attr.c_str()
+                x[token.decode("utf8")] = c_attr.value
+            sequence.append(x)
+        return sequence
+
+    def __len__(self):
+        return self.c_sequence.size()
+
+    def __repr__(self):
+        return f"<ItemSequence ({len(self)})>"

chaine/_core/crfsuite/COPYING

@@ -0,0 +1,27 @@
+The BSD license.
+
+Copyright (c) 2007-2010, Naoaki Okazaki
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the names of the authors nor the names of its contributors
+      may be used to endorse or promote products derived from this
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

chaine/_core/crfsuite/README

@@ -0,0 +1,183 @@
+                               CRFsuite
+                              Version 0.12
+                 http://www.chokkan.org/software/crfsuite/
+
+
+
+* INTRODUCTION
+CRFSuite is an implementation of Conditional Random Fields (CRFs) for
+labeling sequential data. Please refer to the web site for more
+information about this software.
+
+
+
+* COPYRIGHT AND LICENSING INFORMATION
+
+This program is distributed under the modified BSD license. Refer to
+COPYING file for the precise description of the license.
+
+
+Portions of this software are based on libLBFGS.
+
+The MIT License
+
+Copyright (c) 1990 Jorge Nocedal
+Copyright (c) 2007 Naoaki Okazaki
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+Portions of this software are based on Constant Quark Database (CQDB).
+
+The BSD license.
+
+Copyright (c) 2007, Naoaki Okazaki
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Northwestern University, University of Tokyo,
+      nor the names of its contributors may be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+Portions of this software are based on RumAVL.
+
+MIT/X Consortium License.
+
+Copyright (c) 2005-2007 Jesse Long <jpl@unknown.za.net>
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+   1. The above copyright notice and this permission notice shall be
+      included in all copies or substantial portions of the Software.
+   2. The origin of the Software must not be misrepresented; you must not
+      claim that you wrote the original Software.
+   3. Altered source versions of the Software must be plainly marked as
+      such, and must not be misrepresented as being the original Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+
+Portions of this software are based on a portable stdint.h (for MSVC).
+
+Copyright (c) 2005-2007 Paul Hsieh
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+    Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+    Redistributions in binary form must not misrepresent the orignal
+    source in the documentation and/or other materials provided
+    with the distribution.
+
+    The names of the authors nor its contributors may be used to
+    endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+Portions of this software are based on Mersenne Twister.
+
+Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
+All rights reserved.                          
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+  1. Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+  3. The names of its contributors may not be used to endorse or promote 
+     products derived from this software without specific prior written 
+     permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+
+* SPECIAL THANKS GOES TO...
+Olivier Grisel
+Andreas Holzbach
+Baoli Li
+Yoshimasa Tsuruoka
+Hiroshi Manabe
+Riza Theresa B. Batista-Navarro
+
+