spark-nlp 2.6.3rc1__py2.py3-none-any.whl → 6.2.1__py2.py3-none-any.whl

sparknlp/annotator/embeddings/instructor_embeddings.py

@@ -0,0 +1,204 @@
+#  Copyright 2017-2022 John Snow Labs
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+"""Contains classes for BertEmbeddings."""
+
+from sparknlp.common import *
+
+
+class InstructorEmbeddings(AnnotatorModel,
+                           HasEmbeddingsProperties,
+                           HasCaseSensitiveProperties,
+                           HasStorageRef,
+                           HasBatchedAnnotate,
+                           HasMaxSentenceLengthLimit):
+    """Sentence embeddings using INSTRUCTOR.
+
+    Instructor👨‍🏫, an instruction-finetuned text embedding model that can generate text embeddings tailored to any task (e.g., classification, retrieval, clustering, text evaluation, etc.) and domains (e.g., science, finance, etc.) by simply providing the task instruction, without any finetuning. Instructor👨‍ achieves sota on 70 diverse embedding tasks!
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> embeddings = InstructorEmbeddings.pretrained() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setInstruction("Represent the Medicine sentence for clustering: ") \\
+    ...     .setOutputCol("instructor_embeddings")
+
+
+    The default model is ``"instructor_base"``, if no name is provided.
+
+    For available pretrained models please see the
+    `Models Hub <https://sparknlp.org/models?q=Instructor>`__.
+
+
+    ====================== ======================
+    Input Annotation types Output Annotation type
+    ====================== ======================
+    ``DOCUMENT``            ``SENTENCE_EMBEDDINGS``
+    ====================== ======================
+
+    Parameters
+    ----------
+    batchSize
+        Size of every batch , by default 8
+    dimension
+        Number of embedding dimensions, by default 768
+    caseSensitive
+        Whether to ignore case in tokens for embeddings matching, by default False
+    instruction
+        Set transformer instruction, e.g. 'summarize:'
+    maxSentenceLength
+        Max sentence length to process, by default 128
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+
+    References
+    ----------
+    `One Embedder, Any Task: Instruction-Finetuned Text Embeddings <https://arxiv.org/abs/2212.09741>`__
+
+    https://github.com/HKUNLP/instructor-embedding/
+
+    **Paper abstract**
+
+    *We introduce INSTRUCTOR, a new method for computing text embeddings given task instructions:
+    every text input is embedded together with instructions explaining the use case (e.g., task and
+    domain descriptions). Unlike encoders from prior work that are more specialized, INSTRUCTOR is a
+    single embedder that can generate text embeddings tailored to different downstream tasks and domains,
+    without any further training. We first annotate instructions for 330 diverse tasks and train INSTRUCTOR
+    on this multitask mixture with a contrastive loss. We evaluate INSTRUCTOR on 70 embedding evaluation tasks
+    (66 of which are unseen during training), ranging from classification and information retrieval to semantic
+    textual similarity and text generation evaluation. INSTRUCTOR, while having an order of magnitude fewer
+    parameters than the previous best model, achieves state-of-the-art performance, with an average improvement
+    of 3.4% compared to the previous best results on the 70 diverse datasets. Our analysis suggests that
+    INSTRUCTOR is robust to changes in instructions, and that instruction finetuning mitigates the challenge of
+    training a single model on diverse datasets. Our model, code, and data are available at this https
+    URL <https://instructor-embedding.github.io/>.*
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> documentAssembler = DocumentAssembler() \\
+    ...     .setInputCol("text") \\
+    ...     .setOutputCol("document")
+    >>> embeddings = InstructorEmbeddings.pretrained() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setInstruction("Represent the Medicine sentence for clustering: ") \\
+    ...     .setOutputCol("instructor_embeddings")
+    >>> embeddingsFinisher = EmbeddingsFinisher() \\
+    ...     .setInputCols(["instructor_embeddings"]) \\
+    ...     .setOutputCols("finished_embeddings") \\
+    ...     .setOutputAsVector(True)
+    >>> pipeline = Pipeline().setStages([
+    ...     documentAssembler,
+    ...     embeddings,
+    ...     embeddingsFinisher
+    ... ])
+    >>> data = spark.createDataFrame([["Dynamical Scalar Degree of Freedom in Horava-Lifshitz Gravity"]]).toDF("text")
+    >>> result = pipeline.fit(data).transform(data)
+    >>> result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+    +--------------------------------------------------------------------------------+
+    |                                                                          result|
+    +--------------------------------------------------------------------------------+
+    |[-2.3497989177703857,0.480538547039032,-0.3238905668258667,-1.612930893898010...|
+    +--------------------------------------------------------------------------------+
+    """
+
+    name = "InstructorEmbeddings"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
+
+    outputAnnotatorType = AnnotatorType.SENTENCE_EMBEDDINGS
+    instruction = Param(Params._dummy(), "instruction", "Set transformer instruction, e.g. 'summarize:'",
+                        typeConverter=TypeConverters.toString)
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+    def setInstruction(self, value):
+        """ Sets transformer instruction, e.g. 'summarize:'.
+
+        Parameters
+        ----------
+        value : str
+        """
+        return self._set(instruction=value)
+
+    def setConfigProtoBytes(self, b):
+        """Sets configProto from tensorflow, serialized into byte array.
+
+        Parameters
+        ----------
+        b : List[int]
+            ConfigProto from tensorflow, serialized into byte array
+        """
+        return self._set(configProtoBytes=b)
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.embeddings.InstructorEmbeddings", java_model=None):
+        super(InstructorEmbeddings, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            dimension=768,
+            batchSize=8,
+            maxSentenceLength=128,
+            caseSensitive=False,
+            instruction="",
+        )
+
+    @staticmethod
+    def loadSavedModel(folder, spark_session):
+        """Loads a locally saved model.
+
+        Parameters
+        ----------
+        folder : str
+            Folder of the saved model
+        spark_session : pyspark.sql.SparkSession
+            The current SparkSession
+
+        Returns
+        -------
+        InstructorEmbeddings
+            The restored model
+        """
+        from sparknlp.internal import _InstructorLoader
+        jModel = _InstructorLoader(folder, spark_session._jsparkSession)._java_obj
+        return InstructorEmbeddings(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="instructor_base", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default "instructor_base"
+        lang : str, optional
+            Language of the pretrained model, by default "en"
+        remote_loc : str, optional
+            Optional remote address of the resource, by default None. Will use
+            Spark NLPs repositories otherwise.
+
+        Returns
+        -------
+        InstructorEmbeddings
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(InstructorEmbeddings, name, lang, remote_loc)

sparknlp/annotator/embeddings/longformer_embeddings.py

@@ -0,0 +1,211 @@
+#  Copyright 2017-2022 John Snow Labs
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+"""Contains classes for LongformerEmbeddings."""
+
+from sparknlp.common import *
+
+
+class LongformerEmbeddings(AnnotatorModel,
+                           HasEmbeddingsProperties,
+                           HasCaseSensitiveProperties,
+                           HasStorageRef,
+                           HasBatchedAnnotate,
+                           HasEngine,
+                           HasLongMaxSentenceLengthLimit):
+    """Longformer is a transformer model for long documents. The Longformer
+    model was presented in `Longformer: The Long-Document Transformer` by Iz
+    Beltagy, Matthew E. Peters, Arman Cohan. longformer-base-4096 is a BERT-like
+    model started from the RoBERTa checkpoint and pretrained for MLM on long
+    documents. It supports sequences of length up to 4,096.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> embeddings = LongformerEmbeddings.pretrained() \\
+    ...     .setInputCols(["document", "token"]) \\
+    ...     .setOutputCol("embeddings")
+
+
+    The default model is ``"longformer_base_4096"``, if no name is provided. For
+    available pretrained models please see the `Models Hub
+    <https://sparknlp.org/models?task=Embeddings>`__.
+
+    To see which models are compatible and how to import them see
+    `Import Transformers into Spark NLP 🚀
+    <https://github.com/JohnSnowLabs/spark-nlp/discussions/5669>`_.
+
+    ====================== ======================
+    Input Annotation types Output Annotation type
+    ====================== ======================
+    ``DOCUMENT, TOKEN``    ``WORD_EMBEDDINGS``
+    ====================== ======================
+
+    Parameters
+    ----------
+    batchSize
+        Size of every batch, by default 8
+    dimension
+        Number of embedding dimensions, by default 768
+    caseSensitive
+        Whether to ignore case in tokens for embeddings matching, by default
+        True
+    maxSentenceLength
+        Max sentence length to process, by default 1024
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+
+    References
+    ----------
+    `Longformer: The Long-Document Transformer
+    <https://arxiv.org/pdf/2004.05150.pdf>`__
+
+
+    **Paper Abstract:**
+
+    *Transformer-based models are unable to process long sequences due to their
+    self-attention operation, which scales quadratically with the sequence
+    length. To address this limitation, we introduce the Longformer with an
+    attention mechanism that scales linearly with sequence length, making it
+    easy to process documents of thousands of tokens or longer. Longformer's
+    attention mechanism is a drop-in replacement for the standard self-attention
+    and combines a local windowed attention with a task motivated global
+    attention. Following prior work on long-sequence transformers, we evaluate
+    Longformer on character-level language modeling and achieve state-of-the-art
+    results on text8 and enwik8. In contrast to most prior work, we also
+    pretrain Longformer and finetune it on a variety of downstream tasks. Our
+    pretrained Longformer consistently outperforms RoBERTa on long document
+    tasks and sets new state-of-the-art results on WikiHop and TriviaQA. We
+    finally introduce the Longformer-Encoder-Decoder (LED), a Longformer variant
+    for supporting long document generative sequence-to-sequence tasks, and
+    demonstrate its effectiveness on the arXiv summarization dataset.*
+
+    The original code can be found at `Longformer: The Long-Document Transformer
+    <https://github.com/allenai/longformer>`__.
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> documentAssembler = DocumentAssembler() \\
+    ...     .setInputCol("text") \\
+    ...     .setOutputCol("document")
+    >>> tokenizer = Tokenizer() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setOutputCol("token")
+    >>> embeddings = LongformerEmbeddings.pretrained() \\
+    ...     .setInputCols(["document", "token"]) \\
+    ...     .setOutputCol("embeddings") \\
+    ...     .setCaseSensitive(True)
+    >>> embeddingsFinisher = EmbeddingsFinisher() \\
+    >>>     .setInputCols(["embeddings"]) \\
+    ...     .setOutputCols("finished_embeddings") \\
+    ...     .setOutputAsVector(True) \\
+    ...     .setCleanAnnotations(False)
+    >>> pipeline = Pipeline() \\
+    ...     .setStages([
+    ...         documentAssembler,
+    ...         tokenizer,
+    ...         embeddings,
+    ...         embeddingsFinisher
+    ...     ])
+    >>> data = spark.createDataFrame([["This is a sentence."]]).toDF("text")
+    >>> result = pipeline.fit(data).transform(data)
+    >>> result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+    +--------------------------------------------------------------------------------+
+    |                                                                          result|
+    +--------------------------------------------------------------------------------+
+    |[0.18792399764060974,-0.14591649174690247,0.20547787845134735,0.1468472778797...|
+    |[0.22845706343650818,0.18073144555091858,0.09725798666477203,-0.0417917296290...|
+    |[0.07037967443466187,-0.14801117777824402,-0.03603338822722435,-0.17893412709...|
+    |[-0.08734266459941864,0.2486150562763214,-0.009067727252840996,-0.24408400058...|
+    |[0.22409197688102722,-0.4312366545200348,0.1401449590921402,0.356410235166549...|
+    +--------------------------------------------------------------------------------+
+    """
+    name = "LongformerEmbeddings"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT, AnnotatorType.TOKEN]
+
+    outputAnnotatorType = AnnotatorType.WORD_EMBEDDINGS
+
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+    def setConfigProtoBytes(self, b):
+        """Sets configProto from tensorflow, serialized into byte array.
+
+        Parameters
+        ----------
+        b : List[int]
+            ConfigProto from tensorflow, serialized into byte array
+        """
+        return self._set(configProtoBytes=b)
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.embeddings.LongformerEmbeddings", java_model=None):
+        super(LongformerEmbeddings, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            dimension=768,
+            batchSize=8,
+            maxSentenceLength=1024,
+            caseSensitive=True
+        )
+
+    @staticmethod
+    def loadSavedModel(folder, spark_session):
+        """Loads a locally saved model.
+
+        Parameters
+        ----------
+        folder : str
+            Folder of the saved model
+        spark_session : pyspark.sql.SparkSession
+            The current SparkSession
+
+        Returns
+        -------
+        LongformerEmbeddings
+            The restored model
+        """
+        from sparknlp.internal import _LongformerLoader
+        jModel = _LongformerLoader(folder, spark_session._jsparkSession)._java_obj
+        return LongformerEmbeddings(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="longformer_base_4096", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default "longformer_base_4096"
+        lang : str, optional
+            Language of the pretrained model, by default "en"
+        remote_loc : str, optional
+            Optional remote address of the resource, by default None. Will use
+            Spark NLPs repositories otherwise.
+
+        Returns
+        -------
+        LongformerEmbeddings
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(LongformerEmbeddings, name, lang, remote_loc)

sparknlp/annotator/embeddings/minilm_embeddings.py

@@ -0,0 +1,189 @@
+#  Copyright 2017-2022 John Snow Labs
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+"""Contains classes for MiniLMEmbeddings."""
+
+from sparknlp.common import *
+
+
+class MiniLMEmbeddings(AnnotatorModel,
+                           HasEmbeddingsProperties,
+                           HasCaseSensitiveProperties,
+                           HasStorageRef,
+                           HasBatchedAnnotate,
+                           HasMaxSentenceLengthLimit):
+    """Sentence embeddings using MiniLM.
+
+    MiniLM, a lightweight and efficient sentence embedding model that can generate text embeddings for various NLP tasks (e.g., classification, retrieval, clustering, text evaluation, etc.)
+    Note that this annotator is only supported for Spark Versions 3.4 and up.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> embeddings = MiniLMEmbeddings.pretrained() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setOutputCol("minilm_embeddings")
+
+
+    The default model is ``"minilm_l6_v2"``, if no name is provided.
+
+    For available pretrained models please see the
+    `Models Hub <https://sparknlp.org/models?q=MiniLM>`__.
+
+
+    ====================== ======================
+    Input Annotation types Output Annotation type
+    ====================== ======================
+    ``DOCUMENT``            ``SENTENCE_EMBEDDINGS``
+    ====================== ======================
+
+    Parameters
+    ----------
+    batchSize
+        Size of every batch , by default 8
+    dimension
+        Number of embedding dimensions, by default 384
+    caseSensitive
+        Whether to ignore case in tokens for embeddings matching, by default False
+    maxSentenceLength
+        Max sentence length to process, by default 512
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+
+    References
+    ----------
+    `MiniLM: Deep Self-Attention Distillation for Task-Agnostic Compression of Pre-Trained Transformers <https://arxiv.org/abs/2002.10957>`__
+
+    `MiniLM Github Repository <https://github.com/microsoft/unilm/tree/master/minilm>`__
+
+    **Paper abstract**
+
+    *We present a simple and effective approach to compress large pre-trained Transformer models
+    by distilling the self-attention module of the last Transformer layer. The compressed model
+    (called MiniLM) can be trained with task-agnostic distillation and then fine-tuned on various
+    downstream tasks. We evaluate MiniLM on the GLUE benchmark and show that it achieves comparable
+    results with BERT-base while being 4.3x smaller and 5.5x faster. We also show that MiniLM can
+    be further compressed to 22x smaller and 12x faster than BERT-base while maintaining comparable
+    performance.*
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> documentAssembler = DocumentAssembler() \\
+    ...     .setInputCol("text") \\
+    ...     .setOutputCol("document")
+    >>> embeddings = MiniLMEmbeddings.pretrained() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setOutputCol("minilm_embeddings")
+    >>> embeddingsFinisher = EmbeddingsFinisher() \\
+    ...     .setInputCols(["minilm_embeddings"]) \\
+    ...     .setOutputCols("finished_embeddings") \\
+    ...     .setOutputAsVector(True)
+    >>> pipeline = Pipeline().setStages([
+    ...     documentAssembler,
+    ...     embeddings,
+    ...     embeddingsFinisher
+    ... ])
+    >>> data = spark.createDataFrame([["This is a sample sentence for embedding generation.",
+    ... "Another example sentence to demonstrate MiniLM embeddings.",
+    ... ]]).toDF("text")
+    >>> result = pipeline.fit(data).transform(data)
+    >>> result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+    +--------------------------------------------------------------------------------+
+    |                                                                          result|
+    +--------------------------------------------------------------------------------+
+    |[[0.1234567, -0.2345678, 0.3456789, -0.4567890, 0.5678901, -0.6789012...|
+    |[[0.2345678, -0.3456789, 0.4567890, -0.5678901, 0.6789012, -0.7890123...|
+    +--------------------------------------------------------------------------------+
+    """
+
+    name = "MiniLMEmbeddings"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
+
+    outputAnnotatorType = AnnotatorType.SENTENCE_EMBEDDINGS
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+
+    def setConfigProtoBytes(self, b):
+        """Sets configProto from tensorflow, serialized into byte array.
+
+        Parameters
+        ----------
+        b : List[int]
+            ConfigProto from tensorflow, serialized into byte array
+        """
+        return self._set(configProtoBytes=b)
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.embeddings.MiniLMEmbeddings", java_model=None):
+        super(MiniLMEmbeddings, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            dimension=384,
+            batchSize=8,
+            maxSentenceLength=512,
+            caseSensitive=False,
+        )
+
+    @staticmethod
+    def loadSavedModel(folder, spark_session, use_openvino=False):
+        """Loads a locally saved model.
+
+        Parameters
+        ----------
+        folder : str
+            Folder of the saved model
+        spark_session : pyspark.sql.SparkSession
+            The current SparkSession
+        use_openvino : bool
+            Use OpenVINO backend
+
+        Returns
+        -------
+        MiniLMEmbeddings
+            The restored model
+        """
+        from sparknlp.internal import _MiniLMLoader
+        jModel = _MiniLMLoader(folder, spark_session._jsparkSession, use_openvino)._java_obj
+        return MiniLMEmbeddings(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="minilm_l6_v2", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default "minilm_l6_v2"
+        lang : str, optional
+            Language of the pretrained model, by default "en"
+        remote_loc : str, optional
+            Optional remote address of the resource, by default None. Will use
+            Spark NLPs repositories otherwise.
+
+        Returns
+        -------
+        MiniLMEmbeddings
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(MiniLMEmbeddings, name, lang, remote_loc)