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

sparknlp/annotator/coref/spanbert_coref.py

@@ -0,0 +1,221 @@
+#  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 the SpanBertCorefModel."""
+
+from sparknlp.common import *
+
+
+class SpanBertCorefModel(AnnotatorModel,
+                         HasEmbeddingsProperties,
+                         HasCaseSensitiveProperties,
+                         HasStorageRef,
+                         HasEngine,
+                         HasMaxSentenceLengthLimit):
+    """
+    A coreference resolution model based on SpanBert.
+
+    A coreference resolution model identifies expressions which refer to the same entity in a text. For example, given
+    a sentence "John told Mary he would like to borrow a book from her." the model will link "he" to "John" and "her"
+    to "Mary".
+
+    This model is based on SpanBert, which is fine-tuned on the OntoNotes 5.0 data set.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion object:
+
+    >>> corefResolution = SpanBertCorefModel.pretrained() \\
+    ...     .setInputCols(["sentence", "token"]) \\
+    ...     .setOutputCol("coref")
+
+    The default model is ``"spanbert_base_coref"``, if no name is provided. For available
+    pretrained models please see the `Models Hub
+    <https://sparknlp.org/models?q=coref>`__.
+
+    For extended examples of usage, see the
+    `Examples <https://github.com/JohnSnowLabs/spark-nlp/blob/master/examples/python/annotation/text/english/coreference-resolution/Coreference_Resolution_SpanBertCorefModel.ipynb>`__.
+
+    ====================== ======================
+    Input Annotation types Output Annotation type
+    ====================== ======================
+    ``DOCUMENT, TOKEN``    ``DEPENDENCY``
+    ====================== ======================
+
+    Parameters
+    ----------
+    maxSentenceLength
+        Maximum sentence length to process
+    maxSegmentLength
+        Maximum segment length
+    textGenre
+        Text genre. One of the following values:
+
+        | "bc", // Broadcast conversation, default
+        | "bn", // Broadcast news
+        | "nw", // News wire
+        | "pt", // Pivot text: Old Testament and New Testament text
+        | "tc", // Telephone conversation
+        | "wb" // Web data
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> documentAssembler = DocumentAssembler() \\
+    ...     .setInputCol("text") \\
+    ...     .setOutputCol("document")
+    >>> sentence = SentenceDetector() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setOutputCol("sentence")
+    >>> tokenizer = Tokenizer() \\
+    ...     .setInputCols(["sentence"]) \\
+    ...     .setOutputCol("token")
+    >>> corefResolution = SpanBertCorefModel() \\
+    ...     .pretrained() \\
+    ...     .setInputCols(["sentence", "token"]) \\
+    ...     .setOutputCol("corefs") \\
+    >>> pipeline = Pipeline().setStages([
+    ...     documentAssembler,
+    ...     sentence,
+    ...     tokenizer,
+    ...     corefResolution
+    ... ])
+    >>> data = spark.createDataFrame([
+    ...     ["John told Mary he would like to borrow a book from her."]
+    ... ]).toDF("text")
+    >>> results = pipeline.fit(data).transform(data))
+    >>> results \\
+    ...     .selectExpr("explode(corefs) AS coref")
+    ...     .selectExpr("coref.result as token", "coref.metadata")
+    ...     .show(truncate=False)
+    +-----+------------------------------------------------------------------------------------+
+    |token|metadata                                                                            |
+    +-----+------------------------------------------------------------------------------------+
+    |John |{head.sentence -> -1, head -> ROOT, head.begin -> -1, head.end -> -1, sentence -> 0}|
+    |he   |{head.sentence -> 0, head -> John, head.begin -> 0, head.end -> 3, sentence -> 0}   |
+    |Mary |{head.sentence -> -1, head -> ROOT, head.begin -> -1, head.end -> -1, sentence -> 0}|
+    |her  |{head.sentence -> 0, head -> Mary, head.begin -> 10, head.end -> 13, sentence -> 0} |
+    +-----+------------------------------------------------------------------------------------|
+    """
+
+    name = "SpanBertCorefModel"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT, AnnotatorType.TOKEN]
+
+    outputAnnotatorType = AnnotatorType.DEPENDENCY
+
+    maxSegmentLength = Param(Params._dummy(),
+                             "maxSegmentLength",
+                             "Max segment length",
+                             typeConverter=TypeConverters.toInt)
+
+    textGenre = Param(Params._dummy(),
+                      "textGenre",
+                      "Text genre, one of ('bc', 'bn', 'mz', 'nw', 'pt','tc', 'wb')",
+                      typeConverter=TypeConverters.toString)
+
+    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)
+
+    def setMaxSegmentLength(self, value):
+        """Sets max segment length
+
+        Parameters
+        ----------
+        value : int
+            Max segment length
+        """
+        return self._set(maxSegmentLength=value)
+
+    def setTextGenre(self, value):
+        """ Sets the text genre, one of the following values:
+            | "bc" : Broadcast conversation, default
+            | "bn"  Broadcast news
+            | "nw" : News wire
+            | "pt" : Pivot text: Old Testament and New Testament text
+            | "tc" : Telephone conversation
+            | "wb" : Web data
+
+        Parameters
+        ----------
+        value : string
+            Text genre code, default is 'bc'
+        """
+        return self._set(textGenre=value)
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.annotators.coref.SpanBertCorefModel", java_model=None):
+        super(SpanBertCorefModel, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            maxSentenceLength=512,
+            caseSensitive=True,
+            textGenre="bc"
+        )
+
+    @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
+        -------
+        SpanBertCorefModel
+            The restored model
+        """
+        from sparknlp.internal import _SpanBertCorefLoader
+        jModel = _SpanBertCorefLoader(folder, spark_session._jsparkSession)._java_obj
+        return SpanBertCorefModel(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="spanbert_base_coref", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default "spanbert_base_coref"
+        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
+        -------
+        SpanBertCorefModel
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(SpanBertCorefModel, name, lang, remote_loc)

sparknlp/annotator/cv/__init__.py

@@ -0,0 +1,29 @@
+#  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.
+from sparknlp.annotator.cv.vit_for_image_classification import *
+from sparknlp.annotator.cv.swin_for_image_classification import *
+from sparknlp.annotator.cv.convnext_for_image_classification import *
+from sparknlp.annotator.cv.vision_encoder_decoder_for_image_captioning import *
+from sparknlp.annotator.cv.clip_for_zero_shot_classification import *
+from sparknlp.annotator.cv.blip_for_question_answering import *
+from sparknlp.annotator.cv.janus_for_multimodal import *
+from sparknlp.annotator.cv.mllama_for_multimodal import *
+from sparknlp.annotator.cv.qwen2vl_transformer import *
+from sparknlp.annotator.cv.llava_for_multimodal import *
+from sparknlp.annotator.cv.phi3_vision_for_multimodal import *
+from sparknlp.annotator.cv.smolvlm_transformer import *
+from sparknlp.annotator.cv.paligemma_for_multimodal import *
+from sparknlp.annotator.cv.gemma3_for_multimodal import *
+from sparknlp.annotator.cv.internvl_for_multimodal import *
+from sparknlp.annotator.cv.florence2_transformer import *

sparknlp/annotator/cv/blip_for_question_answering.py

@@ -0,0 +1,172 @@
+#  Copyright 2017-2024 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.
+
+from sparknlp.common import *
+
+class BLIPForQuestionAnswering(AnnotatorModel,
+                               HasBatchedAnnotateImage,
+                               HasImageFeatureProperties,
+                               HasEngine,
+                               HasCandidateLabelsProperties,
+                               HasRescaleFactor):
+    """BLIPForQuestionAnswering can load BLIP models  for visual question answering.
+    The model consists of a vision encoder, a text encoder as well as a text decoder.
+    The vision encoder will encode the input image, the text encoder will encode the input question together
+    with the encoding of the image, and the text decoder will output the answer to the question.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> visualQAClassifier = BLIPForQuestionAnswering.pretrained() \\
+    ...     .setInputCols(["image_assembler"]) \\
+    ...     .setOutputCol("answer")
+
+    The default model is ``"blip_vqa_base"``, if no name is
+    provided.
+
+    For available pretrained models please see the `Models Hub
+    <https://sparknlp.org/models?task=Question+Answering>`__.
+
+    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
+    ====================== ======================
+    ``IMAGE``              ``DOCUMENT``
+    ====================== ======================
+
+    Parameters
+    ----------
+    batchSize
+        Batch size. Large values allows faster processing but requires more
+        memory, by default 2
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+    maxSentenceLength
+        Max sentence length to process, by default 50
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> image_df = SparkSessionForTest.spark.read.format("image").load(path=images_path)
+    >>> test_df = image_df.withColumn("text", lit("What's this picture about?"))
+    >>> imageAssembler = ImageAssembler() \\
+    ...     .setInputCol("image") \\
+    ...     .setOutputCol("image_assembler")
+    >>> visualQAClassifier = BLIPForQuestionAnswering.pretrained() \\
+    ...     .setInputCols("image_assembler") \\
+    ...     .setOutputCol("answer") \\
+    ...     .setSize(384)
+    >>> pipeline = Pipeline().setStages([
+    ...     imageAssembler,
+    ...     visualQAClassifier
+    ... ])
+    >>> result = pipeline.fit(test_df).transform(test_df)
+    >>> result.select("image_assembler.origin", "answer.result").show(false)
+    +--------------------------------------+------+
+    |origin                                |result|
+    +--------------------------------------+------+
+    |[file:///content/images/cat_image.jpg]|[cats]|
+    +--------------------------------------+------+
+    """
+
+    name = "BLIPForQuestionAnswering"
+
+    inputAnnotatorTypes = [AnnotatorType.IMAGE]
+
+    outputAnnotatorType = AnnotatorType.DOCUMENT
+
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with "
+                             "config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+    maxSentenceLength = Param(Params._dummy(),
+                            "maxSentenceLength",
+                            "Maximum sentence length that the annotator will process. Above this, the sentence is skipped",
+                            typeConverter=TypeConverters.toInt)
+
+    def setMaxSentenceSize(self, value):
+        """Sets Maximum sentence length that the annotator will process, by
+        default 50.
+
+        Parameters
+        ----------
+        value : int
+            Maximum sentence length that the annotator will process
+        """
+        return self._set(maxSentenceLength=value)
+
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.annotators.cv.BLIPForQuestionAnswering",
+                 java_model=None):
+        super(BLIPForQuestionAnswering, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            batchSize=2,
+            size=384,
+            maxSentenceLength=50
+        )
+
+    @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
+        -------
+        CLIPForZeroShotClassification
+            The restored model
+        """
+        from sparknlp.internal import _BLIPForQuestionAnswering
+        jModel = _BLIPForQuestionAnswering(folder, spark_session._jsparkSession)._java_obj
+        return BLIPForQuestionAnswering(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="blip_vqa_base", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default
+            "blip_vqa_tf"
+        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
+        -------
+        CLIPForZeroShotClassification
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(BLIPForQuestionAnswering, name, lang, remote_loc)

sparknlp/annotator/cv/clip_for_zero_shot_classification.py

@@ -0,0 +1,193 @@
+#  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 concerning CLIPForZeroShotClassification."""
+
+from sparknlp.common import *
+
+
+class CLIPForZeroShotClassification(AnnotatorModel,
+                                    HasBatchedAnnotateImage,
+                                    HasImageFeatureProperties,
+                                    HasEngine,
+                                    HasCandidateLabelsProperties,
+                                    HasRescaleFactor):
+    """Zero Shot Image Classifier based on CLIP.
+
+    CLIP (Contrastive Language-Image Pre-Training) is a neural network that was trained on image
+    and text pairs. It has the ability to predict images without training on any hard-coded
+    labels. This makes it very flexible, as labels can be provided during inference. This is
+    similar to the zero-shot capabilities of the GPT-2 and 3 models.
+
+    Pretrained models can be loaded with ``pretrained`` of the companion object:
+
+
+    .. code-block:: python
+
+        imageClassifier = CLIPForZeroShotClassification.pretrained() \\
+            .setInputCols(["image_assembler"]) \\
+            .setOutputCol("label")
+
+
+    The default model is ``"zero_shot_classifier_clip_vit_base_patch32"``, if no name is provided.
+
+    For available pretrained models please see the
+    `Models Hub <https://sparknlp.org/models?task=Zero-Shot+Classification>`__.
+
+    Models from the HuggingFace 🤗 Transformers library are also compatible with Spark NLP 🚀. To
+    see which models are compatible and how to import them see
+    https://github.com/JohnSnowLabs/spark-nlp/discussions/5669 and to see more extended
+    examples, see
+    `CLIPForZeroShotClassificationTestSpec <https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/cv/CLIPForZeroShotClassificationTestSpec.scala>`__.
+
+    ====================== ======================
+    Input Annotation types Output Annotation type
+    ====================== ======================
+    ``IMAGE``              ``CATEGORY``
+    ====================== ======================
+
+    Parameters
+    ----------
+    batchSize
+        Batch size, by default `2`.
+    candidateLabels
+        Array of labels for classification
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> imageDF = spark.read \\
+    ...     .format("image") \\
+    ...     .option("dropInvalid", value = True) \\
+    ...     .load("src/test/resources/image/")
+    >>> imageAssembler = ImageAssembler() \\
+    ...     .setInputCol("image") \\
+    ...     .setOutputCol("image_assembler")
+    >>> candidateLabels = [
+    ...     "a photo of a bird",
+    ...     "a photo of a cat",
+    ...     "a photo of a dog",
+    ...     "a photo of a hen",
+    ...     "a photo of a hippo",
+    ...     "a photo of a room",
+    ...     "a photo of a tractor",
+    ...     "a photo of an ostrich",
+    ...     "a photo of an ox"]
+    >>> imageClassifier = CLIPForZeroShotClassification \\
+    ...     .pretrained() \\
+    ...     .setInputCols(["image_assembler"]) \\
+    ...     .setOutputCol("label") \\
+    ...     .setCandidateLabels(candidateLabels)
+    >>> pipeline = Pipeline().setStages([imageAssembler, imageClassifier])
+    >>> pipelineDF = pipeline.fit(imageDF).transform(imageDF)
+    >>> pipelineDF \\
+    ...   .selectExpr("reverse(split(image.origin, '/'))[0] as image_name", "label.result") \\
+    ...   .show(truncate=False)
+    +-----------------+-----------------------+
+    |image_name       |result                 |
+    +-----------------+-----------------------+
+    |palace.JPEG      |[a photo of a room]    |
+    |egyptian_cat.jpeg|[a photo of a cat]     |
+    |hippopotamus.JPEG|[a photo of a hippo]   |
+    |hen.JPEG         |[a photo of a hen]     |
+    |ostrich.JPEG     |[a photo of an ostrich]|
+    |junco.JPEG       |[a photo of a bird]    |
+    |bluetick.jpg     |[a photo of a dog]     |
+    |chihuahua.jpg    |[a photo of a dog]     |
+    |tractor.JPEG     |[a photo of a tractor] |
+    |ox.JPEG          |[a photo of an ox]     |
+    +-----------------+-----------------------+
+    """
+    name = "CLIPForZeroShotClassification"
+
+    inputAnnotatorTypes = [AnnotatorType.IMAGE]
+
+    outputAnnotatorType = AnnotatorType.CATEGORY
+
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with "
+                             "config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+    def getCandidateLabels(self):
+        """
+        Returns labels used to train this model
+        """
+        return self._call_java("getCandidateLabels")
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.annotators.cv.CLIPForZeroShotClassification",
+                 java_model=None):
+        super(CLIPForZeroShotClassification, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            batchSize=2,
+            doNormalize=True,
+            doRescale=True,
+            doResize=True,
+            imageMean=[0.48145466, 0.4578275, 0.40821073],
+            imageStd=[0.26862954, 0.26130258, 0.27577711],
+            resample=2,
+            rescaleFactor=1 / 255.0,
+            size=224
+        )
+
+    @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
+        -------
+        CLIPForZeroShotClassification
+            The restored model
+        """
+        from sparknlp.internal import _CLIPForZeroShotClassification
+        jModel = _CLIPForZeroShotClassification(folder, spark_session._jsparkSession)._java_obj
+        return CLIPForZeroShotClassification(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="zero_shot_classifier_clip_vit_base_patch32", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default
+            "image_classifier_vit_base_patch16_224"
+        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
+        -------
+        CLIPForZeroShotClassification
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(CLIPForZeroShotClassification, name, lang, remote_loc)