spark-nlp 5.4.0rc1__py2.py3-none-any.whl → 5.4.1__py2.py3-none-any.whl

sparknlp/annotator/classifier_dl/mpnet_for_token_classification.py

@@ -0,0 +1,173 @@
+#  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 MPNetForTokenClassification."""
+
+from sparknlp.common import *
+
+
+class MPNetForTokenClassification(AnnotatorModel,
+                                       HasCaseSensitiveProperties,
+                                       HasBatchedAnnotate,
+                                       HasEngine,
+                                       HasMaxSentenceLengthLimit):
+    """MPNetForTokenClassification can load XLM-RoBERTa Models with a token
+    classification head on top (a linear layer on top of the hidden-states
+    output) e.g. for Named-Entity-Recognition (NER) tasks.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> token_classifier = MPNetForTokenClassification.pretrained() \\
+    ...     .setInputCols(["token", "document"]) \\
+    ...     .setOutputCol("label")
+    The default model is ``"mpnet_base_token_classifier"``, if no
+    name is provided.
+
+    For available pretrained models please see the `Models Hub
+    <https://sparknlp.org/models?task=Named+Entity+Recognition>`__.
+    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``    ``NAMED_ENTITY``
+    ====================== ======================
+
+    Parameters
+    ----------
+    batchSize
+        Batch size. Large values allows faster processing but requires more
+        memory, by default 8
+    caseSensitive
+        Whether to ignore case in tokens for embeddings matching, by default
+        True
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+    maxSentenceLength
+        Max sentence length to process, by default 128
+
+    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")
+    >>> tokenClassifier = MPNetForTokenClassification.pretrained() \\
+    ...     .setInputCols(["token", "document"]) \\
+    ...     .setOutputCol("label") \\
+    ...     .setCaseSensitive(True)
+    >>> pipeline = Pipeline().setStages([
+    ...     documentAssembler,
+    ...     tokenizer,
+    ...     tokenClassifier
+    ... ])
+    >>> data = spark.createDataFrame([["John Lenon was born in London and lived in Paris. My name is Sarah and I live in London"]]).toDF("text")
+    >>> result = pipeline.fit(data).transform(data)
+    >>> result.select("label.result").show(truncate=False)
+    +------------------------------------------------------------------------------------+
+    |result                                                                              |
+    +------------------------------------------------------------------------------------+
+    |[B-PER, I-PER, O, O, O, B-LOC, O, O, O, B-LOC, O, O, O, O, B-PER, O, O, O, O, B-LOC]|
+    +------------------------------------------------------------------------------------+
+    """
+    name = "MPNetForTokenClassification"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT, AnnotatorType.TOKEN]
+
+    outputAnnotatorType = AnnotatorType.NAMED_ENTITY
+
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+    def getClasses(self):
+        """
+        Returns labels used to train this model
+        """
+        return self._call_java("getClasses")
+
+    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.annotators.classifier.dl.MPNetForTokenClassification",
+                 java_model=None):
+        super(MPNetForTokenClassification, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            batchSize=8,
+            maxSentenceLength=128,
+            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
+        -------
+        XlmRoBertaForTokenClassification
+            The restored model
+        """
+        from sparknlp.internal import _MPNetForTokenClassifierLoader
+        jModel = _MPNetForTokenClassifierLoader(folder, spark_session._jsparkSession)._java_obj
+        return MPNetForTokenClassification(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="mpnet_base_token_classifier", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default
+            "mpnet_base_token_classifier"
+        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
+        -------
+        XlmRoBertaForTokenClassification
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(MPNetForTokenClassification, name, lang, remote_loc)

sparknlp/annotator/classifier_dl/xlm_roberta_for_token_classification.py

@@ -31,7 +31,7 @@ class XlmRoBertaForTokenClassification(AnnotatorModel,
     >>> token_classifier = XlmRoBertaForTokenClassification.pretrained() \\
     ...     .setInputCols(["token", "document"]) \\
     ...     .setOutputCol("label")
-    The default model is ``"xlm_roberta_base_token_classifier_conll03"``, if no
+    The default model is ``"mpnet_base_token_classifier"``, if no
     name is provided.
 
     For available pretrained models please see the `Models Hub
@@ -150,14 +150,14 @@ class XlmRoBertaForTokenClassification(AnnotatorModel,
         return XlmRoBertaForTokenClassification(java_model=jModel)
 
     @staticmethod
-    def pretrained(name="xlm_roberta_base_token_classifier_conll03", lang="en", remote_loc=None):
+    def pretrained(name="mpnet_base_token_classifier", lang="en", remote_loc=None):
         """Downloads and loads a pretrained model.
 
         Parameters
         ----------
         name : str, optional
             Name of the pretrained model, by default
-            "xlm_roberta_base_token_classifier_conll03"
+            "mpnet_base_token_classifier"
         lang : str, optional
             Language of the pretrained model, by default "en"
         remote_loc : str, optional

sparknlp/annotator/embeddings/bge_embeddings.py

@@ -26,6 +26,8 @@ class BGEEmbeddings(AnnotatorModel,
 
    BGE, or BAAI General Embeddings, a model that can map any text to a low-dimensional dense 
   vector which can be used for tasks like retrieval, classification, clustering, or semantic search.
+
+  Note that this annotator is only supported for Spark Versions 3.4 and up.
   
   Pretrained models can be loaded with `pretrained` of the companion object:
 

sparknlp/annotator/embeddings/e5_embeddings.py

@@ -25,6 +25,8 @@ class E5Embeddings(AnnotatorModel,
     """Sentence embeddings using E5.
 
     E5, a weakly supervised text embedding model that can generate text embeddings tailored to any task (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:
 

sparknlp/annotator/embeddings/mpnet_embeddings.py

@@ -28,6 +28,8 @@ class MPNetEmbeddings(AnnotatorModel,
     to inherit the advantages of masked language modeling and permuted language modeling for
     natural language understanding.
 
+    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: