Packages

class Phi3Transformer extends AnnotatorModel[Phi3Transformer] with HasBatchedAnnotate[Phi3Transformer] with ParamsAndFeaturesWritable with WriteOnnxModel with WriteOpenvinoModel with HasGeneratorProperties with WriteSentencePieceModel with HasEngine

Phi-3

The Phi-3-Mini-128K-Instruct is a 3.8 billion-parameter, lightweight, state-of-the-art open model trained using the Phi-3 datasets. This dataset includes both synthetic data and filtered publicly available website data, with an emphasis on high-quality and reasoning-dense properties. The model belongs to the Phi-3 family with the Mini version in two variants 4K and 128K which is the context length (in tokens) that it can support.

After initial training, the model underwent a post-training process that involved supervised fine-tuning and direct preference optimization to enhance its ability to follow instructions and adhere to safety measures. When evaluated against benchmarks that test common sense, language understanding, mathematics, coding, long-term context, and logical reasoning, the Phi-3 Mini-128K-Instruct demonstrated robust and state-of-the-art performance among models with fewer than 13 billion parameters.

Pretrained models can be loaded with pretrained of the companion object:

val phi3 = Phi3Transformer.pretrained()
  .setInputCols("document")
  .setOutputCol("generation")

The default model is "phi_3_mini_128k_instruct_int8", if no name is provided. For available pretrained models please see the Models Hub.

For extended examples of usage, see Phi3TestSpec.

References:

Paper Abstract:

We introduce phi-3-mini, a 3.8 billion parameter language model trained on 3.3 trillion tokens, whose overall performance, as measured by both academic benchmarks and internal testing, rivals that of models such as Mixtral 8x7B and GPT-3.5 (e.g., phi-3-mini achieves 69% on MMLU and 8.38 on MT-bench), despite being small enough to be deployed on a phone. The innovation lies entirely in our dataset for training, a scaled-up version of the one used for phi-2, composed of heavily filtered publicly available web data and synthetic data. The model is also further aligned for robustness, safety, and chat format. We also provide some initial parameter-scaling results with a 7B and 14B models trained for 4.8T tokens, called phi-3-small and phi-3-medium, both significantly more capable than phi-3-mini (e.g., respectively 75% and 78% on MMLU, and 8.7 and 8.9 on MT-bench). Moreover, we also introduce phi-3-vision, a 4.2 billion parameter model based on phi-3-mini with strong reasoning capabilities for image and text prompts.

Note:

This is a very computationally expensive module especially on larger sequence. The use of an accelerator such as GPU is recommended.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.base.DocumentAssembler
import com.johnsnowlabs.nlp.annotators.seq2seq.Phi3Transformer
import org.apache.spark.ml.Pipeline

val documentAssembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("documents")

val phi3 = Phi3Transformer.pretrained("phi_3_mini_128k_instruct_int8")
  .setInputCols(Array("documents"))
  .setMinOutputLength(10)
  .setMaxOutputLength(50)
  .setDoSample(false)
  .setTopK(50)
  .setNoRepeatNgramSize(3)
  .setOutputCol("generation")

val pipeline = new Pipeline().setStages(Array(documentAssembler, phi3))

val data = Seq(
  "My name is Leonardo."
).toDF("text")
val result = pipeline.fit(data).transform(data)

results.select("generation.result").show(truncate = false)
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|result                                                                                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|[ My name is Leonardo. I am a man of letters. I have been a man for many years. I was born in the year 1776. I came to the United States in 1776, and I have lived in the United Kingdom since 1776]|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Linear Supertypes
HasEngine, WriteSentencePieceModel, HasGeneratorProperties, WriteOpenvinoModel, WriteOnnxModel, HasBatchedAnnotate[Phi3Transformer], AnnotatorModel[Phi3Transformer], CanBeLazy, RawAnnotator[Phi3Transformer], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[Phi3Transformer], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Phi3Transformer
  2. HasEngine
  3. WriteSentencePieceModel
  4. HasGeneratorProperties
  5. WriteOpenvinoModel
  6. WriteOnnxModel
  7. HasBatchedAnnotate
  8. AnnotatorModel
  9. CanBeLazy
  10. RawAnnotator
  11. HasOutputAnnotationCol
  12. HasInputAnnotationCols
  13. HasOutputAnnotatorType
  14. ParamsAndFeaturesWritable
  15. HasFeatures
  16. DefaultParamsWritable
  17. MLWritable
  18. Model
  19. Transformer
  20. PipelineStage
  21. Logging
  22. Params
  23. Serializable
  24. Serializable
  25. Identifiable
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Phi3Transformer()
  2. new Phi3Transformer(uid: String)

    uid

    required uid for storing annotator to disk

Type Members

  1. type AnnotationContent = Seq[Row]

    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
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def batchAnnotate(batchedAnnotations: Seq[Array[Annotation]]): Seq[Seq[Annotation]]

    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

    batchedAnnotations

    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
    Phi3Transformer → HasBatchedAnnotate
  13. def batchProcess(rows: Iterator[_]): Iterator[Row]
    Definition Classes
    HasBatchedAnnotate
  14. val batchSize: IntParam

    Size of every batch (Default depends on model).

    Size of every batch (Default depends on model).

    Definition Classes
    HasBatchedAnnotate
  15. val beamSize: IntParam

    Beam size for the beam search algorithm (Default: 4)

    Beam size for the beam search algorithm (Default: 4)

    Definition Classes
    HasGeneratorProperties
  16. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. final def clear(param: Param[_]): Phi3Transformer.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def copy(extra: ParamMap): Phi3Transformer

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. val doSample: BooleanParam

    Whether or not to use sampling, use greedy decoding otherwise (Default: false)

    Whether or not to use sampling, use greedy decoding otherwise (Default: false)

    Definition Classes
    HasGeneratorProperties
  24. val engine: Param[String]

    This param is set internally once via loadSavedModel.

    This param is set internally once via loadSavedModel. That's why there is no setter

    Definition Classes
    HasEngine
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  28. def explainParams(): String
    Definition Classes
    Params
  29. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  32. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  33. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. val generationConfig: StructFeature[GenerationConfig]
  36. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  41. def getBatchSize: Int

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  42. def getBeamSize: Int

    Definition Classes
    HasGeneratorProperties
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  45. def getDoSample: Boolean

    Definition Classes
    HasGeneratorProperties
  46. def getEngine: String

    Definition Classes
    HasEngine
  47. def getGenerationConfig: GenerationConfig
  48. def getIgnoreTokenIds: Array[Int]

  49. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  50. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  51. def getMaxOutputLength: Int

    Definition Classes
    HasGeneratorProperties
  52. def getMinOutputLength: Int

    Definition Classes
    HasGeneratorProperties
  53. def getModelIfNotSet: Phi3

  54. def getNReturnSequences: Int

    Definition Classes
    HasGeneratorProperties
  55. def getNoRepeatNgramSize: Int

    Definition Classes
    HasGeneratorProperties
  56. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  57. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  58. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  59. def getRandomSeed: Option[Long]

    Definition Classes
    HasGeneratorProperties
  60. def getRepetitionPenalty: Double

    Definition Classes
    HasGeneratorProperties
  61. def getStopTokenIds: Array[Int]

    Definition Classes
    HasGeneratorProperties
  62. def getTask: Option[String]

    Definition Classes
    HasGeneratorProperties
  63. def getTemperature: Double

    Definition Classes
    HasGeneratorProperties
  64. def getTopK: Int

    Definition Classes
    HasGeneratorProperties
  65. def getTopP: Double

    Definition Classes
    HasGeneratorProperties
  66. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  67. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  68. def hasParent: Boolean
    Definition Classes
    Model
  69. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  70. var ignoreTokenIds: IntArrayParam

    A list of token ids which are ignored in the decoder's output (Default: Array())

  71. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  72. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type : DOCUMENT

    Input annotator type : DOCUMENT

    Definition Classes
    Phi3Transformer → HasInputAnnotationCols
  74. final val inputCols: StringArrayParam

    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
  75. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  76. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  77. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  78. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  79. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  80. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  81. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  88. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. val maxInputLength: IntParam

    max length of the input sequence (Default: 0)

    max length of the input sequence (Default: 0)

    Definition Classes
    HasGeneratorProperties
  93. val maxOutputLength: IntParam

    Maximum length of the sequence to be generated (Default: 20)

    Maximum length of the sequence to be generated (Default: 20)

    Definition Classes
    HasGeneratorProperties
  94. val minOutputLength: IntParam

    Minimum length of the sequence to be generated (Default: 0)

    Minimum length of the sequence to be generated (Default: 0)

    Definition Classes
    HasGeneratorProperties
  95. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  96. val nReturnSequences: IntParam

    The number of sequences to return from the beam search.

    The number of sequences to return from the beam search.

    Definition Classes
    HasGeneratorProperties
  97. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  98. val noRepeatNgramSize: IntParam

    If set to int > 0, all ngrams of that size can only occur once (Default: 0)

    If set to int > 0, all ngrams of that size can only occur once (Default: 0)

    Definition Classes
    HasGeneratorProperties
  99. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  100. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  101. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    Phi3Transformer → ParamsAndFeaturesWritable
  102. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  103. val outputAnnotatorType: String

    Output annotator type : DOCUMENT

    Output annotator type : DOCUMENT

    Definition Classes
    Phi3Transformer → HasOutputAnnotatorType
  104. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  105. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  106. var parent: Estimator[Phi3Transformer]
    Definition Classes
    Model
  107. val randomSeed: Option[Long]

    Optional Random seed for the model.

    Optional Random seed for the model. Needs to be of type Int.

    Definition Classes
    HasGeneratorProperties
  108. val repetitionPenalty: DoubleParam

    The parameter for repetition penalty (Default: 1.0).

    The parameter for repetition penalty (Default: 1.0). 1.0 means no penalty. See this paper for more details.

    Definition Classes
    HasGeneratorProperties
  109. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  110. def set[T](feature: StructFeature[T], value: T): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. def set[T](feature: SetFeature[T], value: Set[T]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  113. def set[T](feature: ArrayFeature[T], value: Array[T]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  114. final def set(paramPair: ParamPair[_]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    Params
  115. final def set(param: String, value: Any): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    Params
  116. final def set[T](param: Param[T], value: T): Phi3Transformer.this.type
    Definition Classes
    Params
  117. def setBatchSize(size: Int): Phi3Transformer.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  118. def setBeamSize(beamNum: Int): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  119. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  120. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  121. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  122. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  123. final def setDefault(paramPairs: ParamPair[_]*): Phi3Transformer.this.type
    Attributes
    protected
    Definition Classes
    Params
  124. final def setDefault[T](param: Param[T], value: T): Phi3Transformer.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  125. def setDoSample(value: Boolean): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  126. def setGenerationConfig(value: GenerationConfig): Phi3Transformer.this.type
  127. def setIgnoreTokenIds(tokenIds: Array[Int]): Phi3Transformer.this.type

  128. final def setInputCols(value: String*): Phi3Transformer.this.type
    Definition Classes
    HasInputAnnotationCols
  129. def setInputCols(value: Array[String]): Phi3Transformer.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  130. def setLazyAnnotator(value: Boolean): Phi3Transformer.this.type
    Definition Classes
    CanBeLazy
  131. def setMaxInputLength(value: Int): Phi3Transformer.this.type
    Definition Classes
    HasGeneratorProperties
  132. def setMaxOutputLength(value: Int): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  133. def setMinOutputLength(value: Int): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  134. def setModelIfNotSet(spark: SparkSession, onnxWrappers: Option[DecoderWrappers], openvinoWrapper: Option[OpenvinoWrapper], spp: SentencePieceWrapper): Phi3Transformer.this.type

  135. def setNReturnSequences(beamNum: Int): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  136. def setNoRepeatNgramSize(value: Int): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  137. final def setOutputCol(value: String): Phi3Transformer.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  138. def setParent(parent: Estimator[Phi3Transformer]): Phi3Transformer
    Definition Classes
    Model
  139. def setRandomSeed(value: Int): Phi3Transformer.this.type

  140. def setRandomSeed(value: Long): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  141. def setRepetitionPenalty(value: Double): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  142. def setStopTokenIds(value: Array[Int]): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  143. def setTask(value: String): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  144. def setTemperature(value: Double): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  145. def setTopK(value: Int): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  146. def setTopP(value: Double): Phi3Transformer.this.type

    Definition Classes
    HasGeneratorProperties
  147. val stopTokenIds: IntArrayParam

    Stop tokens to terminate the generation

    Stop tokens to terminate the generation

    Definition Classes
    HasGeneratorProperties
  148. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  149. val task: Param[String]

    Set transformer task, e.g.

    Set transformer task, e.g. "summarize:" (Default: "").

    Definition Classes
    HasGeneratorProperties
  150. val temperature: DoubleParam

    The value used to module the next token probabilities (Default: 1.0)

    The value used to module the next token probabilities (Default: 1.0)

    Definition Classes
    HasGeneratorProperties
  151. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  152. val topK: IntParam

    The number of highest probability vocabulary tokens to keep for top-k-filtering (Default: 50)

    The number of highest probability vocabulary tokens to keep for top-k-filtering (Default: 50)

    Definition Classes
    HasGeneratorProperties
  153. val topP: DoubleParam

    If set to float < 1.0, only the most probable tokens with probabilities that add up to topP or higher are kept for generation (Default: 1.0)

    If set to float < 1.0, only the most probable tokens with probabilities that add up to topP or higher are kept for generation (Default: 1.0)

    Definition Classes
    HasGeneratorProperties
  154. final def transform(dataset: Dataset[_]): DataFrame

    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
  155. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  156. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  157. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  158. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  159. val uid: String
    Definition Classes
    Phi3Transformer → Identifiable
  160. def validate(schema: StructType): Boolean

    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
  161. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  162. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  163. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  164. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  165. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  166. def writeOnnxModel(path: String, spark: SparkSession, onnxWrapper: OnnxWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOnnxModel
  167. def writeOnnxModels(path: String, spark: SparkSession, onnxWrappersWithNames: Seq[(OnnxWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOnnxModel
  168. def writeOpenvinoModel(path: String, spark: SparkSession, openvinoWrapper: OpenvinoWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOpenvinoModel
  169. def writeOpenvinoModels(path: String, spark: SparkSession, ovWrappersWithNames: Seq[(OpenvinoWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOpenvinoModel
  170. def writeSentencePieceModel(path: String, spark: SparkSession, spp: SentencePieceWrapper, suffix: String, filename: String): Unit
    Definition Classes
    WriteSentencePieceModel

Inherited from HasEngine

Inherited from WriteSentencePieceModel

Inherited from HasGeneratorProperties

Inherited from WriteOpenvinoModel

Inherited from WriteOnnxModel

Inherited from HasBatchedAnnotate[Phi3Transformer]

Inherited from AnnotatorModel[Phi3Transformer]

Inherited from CanBeLazy

Inherited from RawAnnotator[Phi3Transformer]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[Phi3Transformer]

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

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters