Bugfix: wrong attention mask calculation resulted in wrong embeddings #14496
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several changes to the
BGEEmbeddings
class inpython/sparknlp/annotator/embeddings/bge_embeddings.py
and various Scala files to add new functionality and improve code quality. The most important changes include adding support for the CLS token in sentence embeddings, updating the default pretrained model, and various code refactorings to improve readability and maintainability.Enhancements to
BGEEmbeddings
:HasClsTokenProperties
toBGEEmbeddings
to support the use of the CLS token for sentence embeddings. (python/sparknlp/annotator/embeddings/bge_embeddings.py
) [1] [2] [3]bge_small_en_v1.5
. (python/sparknlp/annotator/embeddings/bge_embeddings.py
)New Class and Methods:
HasClsTokenProperties
class to handle CLS token properties. (python/sparknlp/common/properties.py
)Refactorings and Improvements:
BGE
class to includeuseCLSToken
parameter in various methods and improved tensor handling. (src/main/scala/com/johnsnowlabs/ml/ai/BGE.scala
) [1] [2] [3] [4] [5] [6] [7]Albert
andBart
classes. (src/main/scala/com/johnsnowlabs/ml/ai/Albert.scala
,src/main/scala/com/johnsnowlabs/ml/ai/Bart.scala
) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]These changes collectively enhance the functionality of the
BGEEmbeddings
class and improve the overall code quality in related files.This pull request includes several updates to the attention mask logic across multiple classes in thecom.johnsnowlabs.ml.ai
package. The changes primarily involve modifying the condition used to set the attention mask values.Updates to attention mask logic:
BGE.scala
: Changed the condition for setting attention mask values fromx < 0L
tox == 0L
in bothgetSentenceEmbeddingFromOv
andgetSentenceEmbeddingFromOnnx
methods. [1] [2]E5.scala
: Updated the attention mask condition fromx < 0L
tox == 0L
in thegetSentenceEmbeddingFromOnnx
method. [1] [2]MPNet.scala
: Modified the attention mask condition fromx < this.paddingTokenId
tox == this.paddingTokenId
in thegetSentenceEmbeddingFromOv
andgetSentenceEmbeddingFromOnnx
methods. [1] [2]Mxbai.scala
: Changed the attention mask condition fromx < 0L
tox == 0L
in thegetSentenceEmbeddingFromOnnx
method.Nomic.scala
: Updated the attention mask condition fromx < 0L
tox == 0L
in thegetSentenceEmbeddingFromOnnx
method. [1] [2]SnowFlake.scala
: Modified the attention mask condition fromx < 0L
tox == 0L
in bothgetSentenceEmbeddingFromOv
andgetSentenceEmbeddingFromOnnx
methods. [1] [2]UAE.scala
: Changed the attention mask condition fromx < 0L
tox == 0L
in bothgetSentenceEmbeddingFromOpenvino
andgetSentenceEmbeddingFromOnnx
methods. [1] [2] [3]