Class/Object

com.johnsnowlabs.nlp.embeddings

UniversalSentenceEncoder

Related Docs: object UniversalSentenceEncoder | package embeddings

Permalink

class UniversalSentenceEncoder extends AnnotatorModel[UniversalSentenceEncoder] with HasEmbeddingsProperties with HasStorageRef with WriteTensorflowModel

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.

See https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/embeddings/UniversalSentenceEncoderTestSpec.scala for further reference on how to use this API.

Sources :

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.

Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. UniversalSentenceEncoder
  2. WriteTensorflowModel
  3. HasStorageRef
  4. HasEmbeddingsProperties
  5. AnnotatorModel
  6. CanBeLazy
  7. RawAnnotator
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. HasOutputAnnotatorType
  11. ParamsAndFeaturesWritable
  12. HasFeatures
  13. DefaultParamsWritable
  14. MLWritable
  15. Model
  16. Transformer
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UniversalSentenceEncoder()

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

  2. new UniversalSentenceEncoder(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    UniversalSentenceEncoderAnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    Takes a document and annotations and produces new annotations of this annotator's annotation type

    Takes a document and annotations and produces new annotations of this annotator's annotation type

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    UniversalSentenceEncoderAnnotatorModel
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): UniversalSentenceEncoder.this.type

    Permalink
    Definition Classes
    Params
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. val configProtoBytes: IntArrayParam

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  18. def copy(extra: ParamMap): UniversalSentenceEncoder

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  20. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef
  21. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. def dfAnnotate: UserDefinedFunction

    Permalink

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  23. val dimension: IntParam

    Permalink

    Number of embedding dimensions

    Number of embedding dimensions

    Definition Classes
    UniversalSentenceEncoderHasEmbeddingsProperties
  24. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  26. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  27. def explainParams(): String

    Permalink
    Definition Classes
    Params
  28. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  29. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  31. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  32. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  33. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  34. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  39. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  40. def getConfigProtoBytes: Option[Array[Byte]]

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  41. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  42. def getDimension: Int

    Permalink
    Definition Classes
    HasEmbeddingsProperties
  43. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  44. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  45. def getModelIfNotSet: TensorflowUSE

    Permalink

  46. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  47. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  48. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  49. def getStorageRef: String

    Permalink
    Definition Classes
    HasStorageRef
  50. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  51. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  52. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  53. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  54. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Input annotator type : DOCUMENT

    Input annotator type : DOCUMENT

    Definition Classes
    UniversalSentenceEncoderHasInputAnnotationCols
  57. final val inputCols: StringArrayParam

    Permalink

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  58. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  59. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  60. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  63. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  76. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  77. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  78. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  79. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
  80. val outputAnnotatorType: AnnotatorType

    Permalink

    Output annotator type : SENTENCE_EMBEDDINGS

    Output annotator type : SENTENCE_EMBEDDINGS

    Definition Classes
    UniversalSentenceEncoderHasOutputAnnotatorType
  81. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  82. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  83. var parent: Estimator[UniversalSentenceEncoder]

    Permalink
    Definition Classes
    Model
  84. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  85. def set[T](feature: StructFeature[T], value: T): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. def set[T](feature: SetFeature[T], value: Set[T]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[T](feature: ArrayFeature[T], value: Array[T]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. final def set(paramPair: ParamPair[_]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  90. final def set(param: String, value: Any): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  91. final def set[T](param: Param[T], value: T): UniversalSentenceEncoder.this.type

    Permalink
    Definition Classes
    Params
  92. def setConfigProtoBytes(bytes: Array[Int]): UniversalSentenceEncoder.this.type

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  93. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. final def setDefault(paramPairs: ParamPair[_]*): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  98. final def setDefault[T](param: Param[T], value: T): UniversalSentenceEncoder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. def setDimension(value: Int): UniversalSentenceEncoder.this.type

    Permalink
    Definition Classes
    HasEmbeddingsProperties
  100. final def setInputCols(value: String*): UniversalSentenceEncoder.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  101. final def setInputCols(value: Array[String]): UniversalSentenceEncoder.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  102. def setLazyAnnotator(value: Boolean): UniversalSentenceEncoder.this.type

    Permalink
    Definition Classes
    CanBeLazy
  103. def setModelIfNotSet(spark: SparkSession, tensorflow: TensorflowWrapper): UniversalSentenceEncoder.this.type

    Permalink

  104. final def setOutputCol(value: String): UniversalSentenceEncoder.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  105. def setParent(parent: Estimator[UniversalSentenceEncoder]): UniversalSentenceEncoder

    Permalink
    Definition Classes
    Model
  106. def setStorageRef(value: String): UniversalSentenceEncoder.this.type

    Permalink
    Definition Classes
    HasStorageRef
  107. val storageRef: Param[String]

    Permalink
    Definition Classes
    HasStorageRef
  108. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  109. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  110. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    dataset

    Dataset[Row]

    Definition Classes
    AnnotatorModel → Transformer
  111. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  112. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  113. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    RawAnnotator → PipelineStage
  114. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  115. val uid: String

    Permalink
    Definition Classes
    UniversalSentenceEncoder → Identifiable
  116. def validate(schema: StructType): Boolean

    Permalink

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    RawAnnotator
  117. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

    Permalink
    Definition Classes
    HasStorageRef
  118. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  122. def wrapEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String] = None): Column

    Permalink
    Attributes
    protected
    Definition Classes
    HasEmbeddingsProperties
  123. def wrapSentenceEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String] = None): Column

    Permalink
    Attributes
    protected
    Definition Classes
    HasEmbeddingsProperties
  124. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  125. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String = "_use"): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  126. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from WriteTensorflowModel

Inherited from HasStorageRef

Inherited from HasEmbeddingsProperties

Inherited from CanBeLazy

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[UniversalSentenceEncoder]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters