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

sparknlp/annotator/embeddings/snowflake_embeddings.py

@@ -0,0 +1,202 @@
+#  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 SnowFlakeEmbeddings."""
+
+from sparknlp.common import *
+
+
+class SnowFlakeEmbeddings(AnnotatorModel,
+					HasEmbeddingsProperties,
+					HasCaseSensitiveProperties,
+					HasStorageRef,
+					HasBatchedAnnotate,
+					HasMaxSentenceLengthLimit):
+	"""Sentence embeddings using SnowFlake.
+
+    snowflake-arctic-embed is a suite of text embedding models that focuses on creating
+    high-quality retrieval models optimized for performance.
+
+	Pretrained models can be loaded with :meth:`.pretrained` of the companion
+	object:
+
+	>>> embeddings = SnowFlakeEmbeddings.pretrained() \\
+	...     .setInputCols(["document"]) \\
+	...     .setOutputCol("SnowFlake_embeddings")
+
+
+	The default model is ``"snowflake_artic_m"``, if no name is provided.
+
+	For available pretrained models please see the
+	`Models Hub <https://sparknlp.org/models?q=SnowFlake>`__.
+
+
+	====================== ======================
+	Input Annotation types Output Annotation type
+	====================== ======================
+	``DOCUMENT``            ``SENTENCE_EMBEDDINGS``
+	====================== ======================
+
+	**References**
+
+	`Arctic-Embed: Scalable, Efficient, and Accurate Text Embedding Models <https://arxiv.org/abs/2405.05374>`__
+	`Snowflake Arctic-Embed Models <https://github.com/Snowflake-Labs/arctic-embed>`__
+
+	**Paper abstract**
+
+	*The models are trained by leveraging existing open-source text representation models, such
+     as bert-base-uncased, and are trained in a multi-stage pipeline to optimize their retrieval
+     performance. First, the models are trained with large batches of query-document pairs where
+     negatives are derived in-batch—pretraining leverages about 400m samples of a mix of public
+     datasets and proprietary web search data. Following pretraining models are further optimized
+     with long training on a smaller dataset (about 1m samples) of triplets of query, positive
+     document, and negative document derived from hard harmful mining. Mining of the negatives and
+     data curation is crucial to retrieval accuracy. A detailed technical report will be available
+     shortly. *
+
+	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
+	maxSentenceLength
+		Max sentence length to process, by default 512
+	configProtoBytes
+		ConfigProto from tensorflow, serialized into byte array.
+
+
+	Examples
+	--------
+	>>> import sparknlp
+	>>> from sparknlp.base import *
+	>>> from sparknlp.annotator import *
+	>>> from pyspark.ml import Pipeline
+	>>> documentAssembler = DocumentAssembler() \\
+	...     .setInputCol("text") \\
+	...     .setOutputCol("document")
+	>>> embeddings = SnowFlakeEmbeddings.pretrained() \\
+	...     .setInputCols(["document"]) \\
+	...     .setOutputCol("embeddings")
+	>>> embeddingsFinisher = EmbeddingsFinisher() \\
+	...     .setInputCols("embeddings") \\
+	...     .setOutputCols("finished_embeddings") \\
+	...     .setOutputAsVector(True)
+	>>> pipeline = Pipeline().setStages([
+	...     documentAssembler,
+	...     embeddings,
+	...     embeddingsFinisher
+	... ])
+	>>> data = spark.createDataFrame([["hello world", "hello moon"]]).toDF("text")
+	>>> result = pipeline.fit(data).transform(data)
+	>>> result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+	+--------------------------------------------------------------------------------+
+	|                                                                          result|
+	+--------------------------------------------------------------------------------+
+	|[0.50387806, 0.5861606, 0.35129607, -0.76046336, -0.32446072, -0.117674336, 0...|
+	|[0.6660665, 0.961762, 0.24854276, -0.1018044, -0.6569202, 0.027635604, 0.1915...|
+	+--------------------------------------------------------------------------------+
+	"""
+
+	name = "SnowFlakeEmbeddings"
+
+	inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
+
+	outputAnnotatorType = AnnotatorType.SENTENCE_EMBEDDINGS
+	poolingStrategy = Param(Params._dummy(),
+							"poolingStrategy",
+							"Pooling strategy to use for sentence embeddings",
+							TypeConverters.toString)
+
+	def setPoolingStrategy(self, value):
+		"""Pooling strategy to use for sentence embeddings.
+
+		Available pooling strategies for sentence embeddings are:
+		  - `"cls"`: leading `[CLS]` token
+		  - `"cls_avg"`: leading `[CLS]` token + mean of all other tokens
+		  - `"last"`: embeddings of the last token in the sequence
+		  - `"avg"`: mean of all tokens
+		  - `"max"`: max of all embedding features of the entire token sequence
+		  - `"int"`: An integer number, which represents the index of the token to use as the
+			embedding
+
+		Parameters
+		----------
+		value : str
+			Pooling strategy to use for sentence embeddings
+		"""
+
+		valid_strategies = {"cls", "cls_avg", "last", "avg", "max"}
+		if value in valid_strategies or value.isdigit():
+			return self._set(poolingStrategy=value)
+		else:
+			raise ValueError(f"Invalid pooling strategy: {value}. "
+							 f"Valid strategies are: {', '.join(self.valid_strategies)} or an integer.")
+
+	@keyword_only
+	def __init__(self, classname="com.johnsnowlabs.nlp.embeddings.SnowFlakeEmbeddings", java_model=None):
+		super(SnowFlakeEmbeddings, self).__init__(
+			classname=classname,
+			java_model=java_model
+		)
+		self._setDefault(
+			dimension=1024,
+			batchSize=8,
+			maxSentenceLength=512,
+			caseSensitive=False,
+			poolingStrategy="cls"
+		)
+
+	@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
+		-------
+		SnowFlakeEmbeddings
+			The restored model
+		"""
+		from sparknlp.internal import _SnowFlakeEmbeddingsLoader
+		jModel = _SnowFlakeEmbeddingsLoader(folder, spark_session._jsparkSession)._java_obj
+		return SnowFlakeEmbeddings(java_model=jModel)
+
+	@staticmethod
+	def pretrained(name="snowflake_artic_m", lang="en", remote_loc=None):
+		"""Downloads and loads a pretrained model.
+
+		Parameters
+		----------
+		name : str, optional
+			Name of the pretrained model, by default "snowflake_artic_m"
+		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
+		-------
+		SnowFlakeEmbeddings
+			The restored model
+		"""
+		from sparknlp.pretrained import ResourceDownloader
+		return ResourceDownloader.downloadModel(SnowFlakeEmbeddings, name, lang, remote_loc)

sparknlp/annotator/embeddings/uae_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 UAEEmbeddings."""
+
+from sparknlp.common import *
+
+
+class UAEEmbeddings(AnnotatorModel,
+                    HasEmbeddingsProperties,
+                    HasCaseSensitiveProperties,
+                    HasStorageRef,
+                    HasBatchedAnnotate,
+                    HasMaxSentenceLengthLimit):
+    """Sentence embeddings using Universal AnglE Embedding (UAE).
+
+    UAE is a novel angle-optimized text embedding model, designed to improve semantic textual
+    similarity tasks, which are crucial for Large Language Model (LLM) applications. By
+    introducing angle optimization in a complex space, AnglE effectively mitigates saturation of
+    the cosine similarity function.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> embeddings = UAEEmbeddings.pretrained() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setOutputCol("UAE_embeddings")
+
+
+    The default model is ``"uae_large_v1"``, if no name is provided.
+
+    For available pretrained models please see the
+    `Models Hub <https://sparknlp.org/models?q=UAE>`__.
+
+
+    ====================== ======================
+    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
+    maxSentenceLength
+        Max sentence length to process, by default 512
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+
+    References
+    ----------
+
+    `AnglE-optimized Text Embeddings <https://arxiv.org/abs/2309.12871>`__
+    `UAE Github Repository <https://github.com/baochi0212/uae-embedding>`__
+
+    **Paper abstract**
+
+    *High-quality text embedding is pivotal in improving semantic textual similarity (STS) tasks,
+    which are crucial components in Large Language Model (LLM) applications. However, a common
+    challenge existing text embedding models face is the problem of vanishing gradients, primarily
+    due to their reliance on the cosine function in the optimization objective, which has
+    saturation zones. To address this issue, this paper proposes a novel angle-optimized text
+    embedding model called AnglE. The core idea of AnglE is to introduce angle optimization in a
+    complex space. This novel approach effectively mitigates the adverse effects of the saturation
+    zone in the cosine function, which can impede gradient and hinder optimization processes. To
+    set up a comprehensive STS evaluation, we experimented on existing short-text STS datasets and
+    a newly collected long-text STS dataset from GitHub Issues. Furthermore, we examine
+    domain-specific STS scenarios with limited labeled data and explore how AnglE works with
+    LLM-annotated data. Extensive experiments were conducted on various tasks including short-text
+    STS, long-text STS, and domain-specific STS tasks. The results show that AnglE outperforms the
+    state-of-the-art (SOTA) STS models that ignore the cosine saturation zone. These findings
+    demonstrate the ability of AnglE to generate high-quality text embeddings and the usefulness
+    of angle optimization in STS.*
+
+    Examples
+    --------
+    >>> import sparknlp
+    >>> from sparknlp.base import *
+    >>> from sparknlp.annotator import *
+    >>> from pyspark.ml import Pipeline
+    >>> documentAssembler = DocumentAssembler() \\
+    ...     .setInputCol("text") \\
+    ...     .setOutputCol("document")
+    >>> embeddings = UAEEmbeddings.pretrained() \\
+    ...     .setInputCols(["document"]) \\
+    ...     .setOutputCol("embeddings")
+    >>> embeddingsFinisher = EmbeddingsFinisher() \\
+    ...     .setInputCols("embeddings") \\
+    ...     .setOutputCols("finished_embeddings") \\
+    ...     .setOutputAsVector(True)
+    >>> pipeline = Pipeline().setStages([
+    ...     documentAssembler,
+    ...     embeddings,
+    ...     embeddingsFinisher
+    ... ])
+    >>> data = spark.createDataFrame([["hello world", "hello moon"]]).toDF("text")
+    >>> result = pipeline.fit(data).transform(data)
+    >>> result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+    +--------------------------------------------------------------------------------+
+    |                                                                          result|
+    +--------------------------------------------------------------------------------+
+    |[0.50387806, 0.5861606, 0.35129607, -0.76046336, -0.32446072, -0.117674336, 0...|
+    |[0.6660665, 0.961762, 0.24854276, -0.1018044, -0.6569202, 0.027635604, 0.1915...|
+    +--------------------------------------------------------------------------------+
+    """
+
+    name = "UAEEmbeddings"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
+
+    outputAnnotatorType = AnnotatorType.SENTENCE_EMBEDDINGS
+    poolingStrategy = Param(Params._dummy(),
+                            "poolingStrategy",
+                            "Pooling strategy to use for sentence embeddings",
+                            TypeConverters.toString)
+
+    def setPoolingStrategy(self, value):
+        """Pooling strategy to use for sentence embeddings.
+
+        Available pooling strategies for sentence embeddings are:
+          - `"cls"`: leading `[CLS]` token
+          - `"cls_avg"`: leading `[CLS]` token + mean of all other tokens
+          - `"last"`: embeddings of the last token in the sequence
+          - `"avg"`: mean of all tokens
+          - `"max"`: max of all embedding features of the entire token sequence
+          - `"int"`: An integer number, which represents the index of the token to use as the
+            embedding
+
+        Parameters
+        ----------
+        value : str
+            Pooling strategy to use for sentence embeddings
+        """
+
+        valid_strategies = {"cls", "cls_avg", "last", "avg", "max"}
+        if value in valid_strategies or value.isdigit():
+            return self._set(poolingStrategy=value)
+        else:
+            raise ValueError(f"Invalid pooling strategy: {value}. "
+                             f"Valid strategies are: {', '.join(self.valid_strategies)} or an integer.")
+
+    @keyword_only
+    def __init__(self, classname="com.johnsnowlabs.nlp.embeddings.UAEEmbeddings", java_model=None):
+        super(UAEEmbeddings, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            dimension=1024,
+            batchSize=8,
+            maxSentenceLength=512,
+            caseSensitive=False,
+            poolingStrategy="cls"
+        )
+
+    @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
+        -------
+        UAEEmbeddings
+            The restored model
+        """
+        from sparknlp.internal import _UAEEmbeddingsLoader
+        jModel = _UAEEmbeddingsLoader(folder, spark_session._jsparkSession)._java_obj
+        return UAEEmbeddings(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="uae_large_v1", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default "UAE_small"
+        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
+        -------
+        UAEEmbeddings
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(UAEEmbeddings, name, lang, remote_loc)

sparknlp/annotator/embeddings/universal_sentence_encoder.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 the UniversalSentenceEncoder."""
+
+from sparknlp.common import *
+
+
+class UniversalSentenceEncoder(AnnotatorModel,
+                               HasEmbeddingsProperties,
+                               HasStorageRef,
+                               HasBatchedAnnotate,
+                               HasEngine):
+    """The Universal Sentence Encoder encodes text into high dimensional vectors
+    that can be used for text classification, semantic similarity, clustering
+    and other natural language tasks.
+
+    Pretrained models can be loaded with :meth:`.pretrained` of the companion
+    object:
+
+    >>> useEmbeddings = UniversalSentenceEncoder.pretrained() \\
+    ...     .setInputCols(["sentence"]) \\
+    ...     .setOutputCol("sentence_embeddings")
+
+
+    The default model is ``"tfhub_use"``, if no name is provided. For available
+    pretrained models please see the `Models Hub
+    <https://sparknlp.org/models?task=Embeddings>`__.
+
+    For extended examples of usage, see the `Examples
+    <https://github.com/JohnSnowLabs/spark-nlp/blob/master/examples/python/training/english/classification/ClassifierDL_Train_multi_class_news_category_classifier.ipynb>`__.
+
+    ====================== =======================
+    Input Annotation types Output Annotation type
+    ====================== =======================
+    ``DOCUMENT``           ``SENTENCE_EMBEDDINGS``
+    ====================== =======================
+
+    Parameters
+    ----------
+    dimension
+        Number of embedding dimensions
+    loadSP
+        Whether to load SentencePiece ops file which is required only by
+        multi-lingual models, by default False
+    configProtoBytes
+        ConfigProto from tensorflow, serialized into byte array.
+
+    References
+    ----------
+    `Universal Sentence Encoder <https://arxiv.org/abs/1803.11175>`__
+
+    https://tfhub.dev/google/universal-sentence-encoder/2
+
+    **Paper abstract:**
+
+    *We present models for encoding sentences into embedding vectors that
+    specifically target transfer learning to other NLP tasks. The models are
+    efficient and result in accurate performance on diverse transfer tasks. Two
+    variants of the encoding models allow for trade-offs between accuracy and
+    compute resources. For both variants, we investigate and report the
+    relationship between model complexity, resource consumption, the
+    availability of transfer task training data, and task performance.
+    Comparisons are made with baselines that use word level transfer learning
+    via pretrained word embeddings as well as baselines do not use any transfer
+    learning. We find that transfer learning using sentence embeddings tends to
+    outperform word level transfer. With transfer learning via sentence
+    embeddings, we observe surprisingly good performance with minimal amounts of
+    supervised training data for a transfer task. We obtain encouraging results
+    on Word Embedding Association Tests (WEAT) targeted at detecting model bias.
+    Our pre-trained sentence encoding models are made freely available for
+    download and on TF Hub.*
+
+    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")
+    >>> embeddings = UniversalSentenceEncoder.pretrained() \\
+    ...     .setInputCols(["sentence"]) \\
+    ...     .setOutputCol("sentence_embeddings")
+    >>> embeddingsFinisher = EmbeddingsFinisher() \\
+    ...     .setInputCols(["sentence_embeddings"]) \\
+    ...     .setOutputCols("finished_embeddings") \\
+    ...     .setOutputAsVector(True) \\
+    ...     .setCleanAnnotations(False)
+    >>> pipeline = Pipeline() \\
+    ...     .setStages([
+    ...       documentAssembler,
+    ...       sentence,
+    ...       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.04616805538535118,0.022307956591248512,-0.044395286589860916,-0.0016493503...|
+    +--------------------------------------------------------------------------------+
+    """
+
+    name = "UniversalSentenceEncoder"
+
+    inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
+
+    outputAnnotatorType = AnnotatorType.SENTENCE_EMBEDDINGS
+
+    loadSP = Param(Params._dummy(), "loadSP",
+                   "Whether to load SentencePiece ops file which is required only by multi-lingual models. "
+                   "This is not changeable after it's set with a pretrained model nor it is compatible with Windows.",
+                   typeConverter=TypeConverters.toBoolean)
+
+    configProtoBytes = Param(Params._dummy(),
+                             "configProtoBytes",
+                             "ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()",
+                             TypeConverters.toListInt)
+
+    def setLoadSP(self, value):
+        """Sets whether to load SentencePiece ops file which is required only by
+        multi-lingual models, by default False.
+
+        Parameters
+        ----------
+        value : bool
+            Whether to load SentencePiece ops file which is required only by
+            multi-lingual models
+        """
+        return self._set(loadSP=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.UniversalSentenceEncoder", java_model=None):
+        super(UniversalSentenceEncoder, self).__init__(
+            classname=classname,
+            java_model=java_model
+        )
+        self._setDefault(
+            loadSP=False,
+            dimension=512,
+            batchSize=2
+        )
+
+    @staticmethod
+    def loadSavedModel(folder, spark_session, loadsp=False):
+        """Loads a locally saved model.
+
+        Parameters
+        ----------
+        folder : str
+            Folder of the saved model
+        spark_session : pyspark.sql.SparkSession
+            The current SparkSession
+
+        Returns
+        -------
+        UniversalSentenceEncoder
+            The restored model
+        """
+        from sparknlp.internal import _USELoader
+        jModel = _USELoader(folder, spark_session._jsparkSession, loadsp)._java_obj
+        return UniversalSentenceEncoder(java_model=jModel)
+
+    @staticmethod
+    def pretrained(name="tfhub_use", lang="en", remote_loc=None):
+        """Downloads and loads a pretrained model.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the pretrained model, by default "tfhub_use"
+        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
+        -------
+        UniversalSentenceEncoder
+            The restored model
+        """
+        from sparknlp.pretrained import ResourceDownloader
+        return ResourceDownloader.downloadModel(UniversalSentenceEncoder, name, lang, remote_loc)