spark-nlp 6.1.3rc1__py2.py3-none-any.whl → 6.1.5__py2.py3-none-any.whl

sparknlp/annotator/classifier_dl/roberta_bert_for_zero_shot_classification.py

@@ -1,225 +0,0 @@
-#  Copyright 2017-2023 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 RoBertaForZeroShotClassification."""
-
-from sparknlp.common import *
-
-
-class RoBertaForZeroShotClassification(AnnotatorModel,
-                                       HasCaseSensitiveProperties,
-                                       HasBatchedAnnotate,
-                                       HasClassifierActivationProperties,
-                                       HasCandidateLabelsProperties,
-                                       HasEngine):
-    """RoBertaForZeroShotClassification using a `ModelForSequenceClassification` trained on NLI (natural language
-    inference) tasks. Equivalent of `RoBertaForSequenceClassification` models, but these models don't require a hardcoded
-    number of potential classes, they can be chosen at runtime. It usually means it's slower but it is much more
-    flexible.
-
-    Note that the model will loop through all provided labels. So the more labels you have, the
-    longer this process will take.
-
-    Any combination of sequences and labels can be passed and each combination will be posed as a premise/hypothesis
-    pair and passed to the pretrained model.
-
-    Pretrained models can be loaded with :meth:`.pretrained` of the companion
-    object:
-
-    >>> sequenceClassifier = RoBertaForZeroShotClassification.pretrained() \\
-    ...     .setInputCols(["token", "document"]) \\
-    ...     .setOutputCol("label")
-
-    The default model is ``"roberta_base_zero_shot_classifier_nli"``, if no name is
-    provided.
-
-    For available pretrained models please see the `Models Hub
-    <https://sparknlp.orgtask=Text+Classification>`__.
-
-    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``    ``CATEGORY``
-    ====================== ======================
-
-    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
-    coalesceSentences
-        Instead of 1 class per sentence (if inputCols is `sentence`) output 1
-        class per document by averaging probabilities in all sentences, by
-        default False
-    activation
-        Whether to calculate logits via Softmax or Sigmoid, by default
-        `"softmax"`.
-
-    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")
-    >>> sequenceClassifier = RoBertaForZeroShotClassification.pretrained() \\
-    ...     .setInputCols(["token", "document"]) \\
-    ...     .setOutputCol("label") \\
-    ...     .setCaseSensitive(True)
-    >>> pipeline = Pipeline().setStages([
-    ...     documentAssembler,
-    ...     tokenizer,
-    ...     sequenceClassifier
-    ... ])
-    >>> data = spark.createDataFrame([["I loved this movie when I was a child.", "It was pretty boring."]]).toDF("text")
-    >>> result = pipeline.fit(data).transform(data)
-    >>> result.select("label.result").show(truncate=False)
-    +------+
-    |result|
-    +------+
-    |[pos] |
-    |[neg] |
-    +------+
-    """
-    name = "RoBertaForZeroShotClassification"
-
-    inputAnnotatorTypes = [AnnotatorType.DOCUMENT, AnnotatorType.TOKEN]
-
-    outputAnnotatorType = AnnotatorType.CATEGORY
-
-    maxSentenceLength = Param(Params._dummy(),
-                              "maxSentenceLength",
-                              "Max sentence length to process",
-                              typeConverter=TypeConverters.toInt)
-
-    configProtoBytes = Param(Params._dummy(),
-                             "configProtoBytes",
-                             "ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()",
-                             TypeConverters.toListInt)
-
-    coalesceSentences = Param(Params._dummy(), "coalesceSentences",
-                              "Instead of 1 class per sentence (if inputCols is '''sentence''') output 1 class per document by averaging probabilities in all sentences.",
-                              TypeConverters.toBoolean)
-
-    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)
-
-    def setMaxSentenceLength(self, value):
-        """Sets max sentence length to process, by default 128.
-
-        Parameters
-        ----------
-        value : int
-            Max sentence length to process
-        """
-        return self._set(maxSentenceLength=value)
-
-    def setCoalesceSentences(self, value):
-        """Instead of 1 class per sentence (if inputCols is '''sentence''') output 1 class per document by averaging
-        probabilities in all sentences. Due to max sequence length limit in almost all transformer models such as RoBerta
-        (512 tokens), this parameter helps to feed all the sentences into the model and averaging all the probabilities
-        for the entire document instead of probabilities per sentence. (Default: true)
-
-        Parameters
-        ----------
-        value : bool
-            If the output of all sentences will be averaged to one output
-        """
-        return self._set(coalesceSentences=value)
-
-    @keyword_only
-    def __init__(self, classname="com.johnsnowlabs.nlp.annotators.classifier.dl.RoBertaForZeroShotClassification",
-                 java_model=None):
-        super(RoBertaForZeroShotClassification, self).__init__(
-            classname=classname,
-            java_model=java_model
-        )
-        self._setDefault(
-            batchSize=8,
-            maxSentenceLength=128,
-            caseSensitive=True,
-            coalesceSentences=False,
-            activation="softmax"
-        )
-
-    @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
-        -------
-        RoBertaForZeroShotClassification
-            The restored model
-        """
-        from sparknlp.internal import _RoBertaForZeroShotClassification
-        jModel = _RoBertaForZeroShotClassification(folder, spark_session._jsparkSession)._java_obj
-        return RoBertaForZeroShotClassification(java_model=jModel)
-
-    @staticmethod
-    def pretrained(name="roberta_base_zero_shot_classifier_nli", lang="en", remote_loc=None):
-        """Downloads and loads a pretrained model.
-
-        Parameters
-        ----------
-        name : str, optional
-            Name of the pretrained model, by default
-            "roberta_base_zero_shot_classifier_nli"
-            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
-        -------
-        RoBertaForZeroShotClassification
-            The restored model
-        """
-        from sparknlp.pretrained import ResourceDownloader
-        return ResourceDownloader.downloadModel(RoBertaForZeroShotClassification, name, lang, remote_loc)

sparknlp/annotator/extractor.py

@@ -1,174 +0,0 @@
-#  Copyright 2017-2025 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 Extractor."""
-from sparknlp.common import *
-
-class Extractor(AnnotatorModel):
-    name = "Extractor"
-
-    inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
-
-    outputAnnotatorType = AnnotatorType.CHUNK
-
-    emailDateTimeTzPattern = Param(Params._dummy(),
-                                   "emailDateTimeTzPattern",
-                                   "Specifies the date-time pattern for email timestamps, including time zone formatting.",
-                                   typeConverter=TypeConverters.toString)
-
-    emailAddress = Param(
-        Params._dummy(),
-        "emailAddress",
-        "Specifies the pattern for email addresses.",
-        typeConverter=TypeConverters.toString
-    )
-
-    ipAddressPattern = Param(
-        Params._dummy(),
-        "ipAddressPattern",
-        "Specifies the pattern for IP addresses.",
-        typeConverter=TypeConverters.toString
-    )
-
-    ipAddressNamePattern = Param(
-        Params._dummy(),
-        "ipAddressNamePattern",
-        "Specifies the pattern for IP addresses with names.",
-        typeConverter=TypeConverters.toString
-    )
-
-    mapiIdPattern = Param(
-        Params._dummy(),
-        "mapiIdPattern",
-        "Specifies the pattern for MAPI IDs.",
-        typeConverter=TypeConverters.toString
-    )
-
-    usPhoneNumbersPattern = Param(
-        Params._dummy(),
-        "usPhoneNumbersPattern",
-        "Specifies the pattern for US phone numbers.",
-        typeConverter=TypeConverters.toString
-    )
-
-    imageUrlPattern = Param(
-        Params._dummy(),
-        "imageUrlPattern",
-        "Specifies the pattern for image URLs.",
-        typeConverter=TypeConverters.toString
-    )
-
-    textPattern = Param(
-        Params._dummy(),
-        "textPattern",
-        "Specifies the pattern for text after and before.",
-        typeConverter=TypeConverters.toString
-    )
-
-    extractorMode = Param(
-        Params._dummy(),
-        "extractorMode",
-        "possible values: " +
-        "email_date, email_address, ip_address, ip_address_name, mapi_id, us_phone_numbers, image_urls, bullets, text_after, text_before",
-        typeConverter=TypeConverters.toString
-    )
-
-    def setEmailDateTimeTzPattern(self, value):
-        """Sets specifies the date-time pattern for email timestamps, including time zone formatting.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the date-time pattern for email timestamps, including time zone formatting.
-        """
-        return self._set(emailDateTimeTzPattern=value)
-
-    def setEmailAddress(self, value):
-        """Sets the pattern for email addresses.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for email addresses.
-        """
-        return self._set(emailAddress=value)
-
-    def setIpAddressPattern(self, value):
-        """Sets the pattern for IP addresses.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for IP addresses.
-        """
-        return self._set(ipAddressPattern=value)
-
-    def setIpAddressNamePattern(self, value):
-        """Sets the pattern for IP addresses with names.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for IP addresses with names.
-        """
-        return self._set(ipAddressNamePattern=value)
-
-    def setMapiIdPattern(self, value):
-        """Sets the pattern for MAPI IDs.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for MAPI IDs.
-        """
-        return self._set(mapiIdPattern=value)
-
-    def setUsPhoneNumbersPattern(self, value):
-        """Sets the pattern for US phone numbers.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for US phone numbers.
-        """
-        return self._set(usPhoneNumbersPattern=value)
-
-    def setImageUrlPattern(self, value):
-        """Sets the pattern for image URLs.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for image URLs.
-        """
-        return self._set(imageUrlPattern=value)
-
-    def setTextPattern(self, value):
-        """Sets the pattern for text after and before.
-
-        Parameters
-        ----------
-        value : str
-            Specifies the pattern for text after and before.
-        """
-        return self._set(textPattern=value)
-
-    def setExtractorMode(self, value):
-        return self._set(extractorMode=value)
-
-    @keyword_only
-    def __init__(self, classname="com.johnsnowlabs.nlp.annotators.Extractor", java_model=None):
-        super(Extractor, self).__init__(
-            classname=classname,
-            java_model=java_model
-        )