Description
The Universal Sentence Encoder Cross-lingual (XLING) module is an extension of the Universal Sentence Encoder that includes training on multiple tasks across languages. The multi-task training setup is based on the paper “Learning Cross-lingual Sentence Representations via a Multi-task Dual Encoder”.
This specific module is trained on English and French (en-fr) tasks, and optimized for greater-than-word length text, such as sentences, phrases or short paragraphs.
It is trained on a variety of data sources and tasks, with the goal of learning text representations that are useful out-of-the-box for a number of applications. The input to the module is variable length English or French text and the output is a 512 dimensional vector.
We note that one does not need to specify the language that the input is in, as the model was trained such that English and French text with similar meanings will have similar (high dot product score) embeddings. We also note that this model can be used for monolingual English (and potentially monolingual French) tasks with comparable or even better performance than the purely English Universal Sentence Encoder.
Note: This model only works on Linux and macOS operating systems and is not compatible with Windows due to the incompatibility of the SentencePiece library.
How to use
...
embeddings = UniversalSentenceEncoder.pretrained("tfhub_use_xling_en_fr", "xx") \
.setInputCols("document") \
.setOutputCol("sentence_embeddings")
nlp_pipeline = Pipeline(stages=[document_assembler, sentence_detector, embeddings])
pipeline_model = nlp_pipeline.fit(spark.createDataFrame([[""]]).toDF("text"))
result = pipeline_model.transform(spark.createDataFrame([['I love NLP', "J'adore utiliser SparkNLP"]], ["text"]))
...
val embeddings = UniversalSentenceEncoder.pretrained("tfhub_use_xling_en_fr", "xx")
.setInputCols("document")
.setOutputCol("sentence_embeddings")
val pipeline = new Pipeline().setStages(Array(document_assembler, sentence_detector, embeddings))
val data = Seq("I love NLP", "J'adore utiliser SparkNLP").toDF("text")
val result = pipeline.fit(data).transform(data)
import nlu
text = ["I love NLP", "J'adore utiliser SparkNLP"]
embeddings_df = nlu.load('xx.use.xling_en_fr').predict(text, output_level='sentence')
embeddings_df
Results
It gives a 512-dimensional vector of the sentences.
sentence xx_use_xling_en_fr_embeddings
0 I love NLP [0.0608731247484684, -0.06734627485275269, -0....
1 J'adore utiliser SparkNLP [0.07564588636159897, -0.06953935325145721, 0....
Model Information
Model Name: | tfhub_use_xling_en_fr |
Compatibility: | Spark NLP 2.7.0+ |
License: | Open Source |
Edition: | Official |
Input Labels: | [sentence] |
Output Labels: | [sentence_embeddings] |
Language: | xx |
Data Source
This embeddings model is imported from https://tfhub.dev/google/universal-sentence-encoder-xling/en-fr/1