Packages

class AutoGGUFModel extends AnnotatorModel[AutoGGUFModel] with HasBatchedAnnotate[AutoGGUFModel] with HasEngine with HasLlamaCppProperties with HasProtectedParams

Annotator that uses the llama.cpp library to generate text completions with large language models.

For settable parameters, and their explanations, see HasLlamaCppProperties and refer to the llama.cpp documentation of server.cpp for more information.

If the parameters are not set, the annotator will default to use the parameters provided by the model.

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

val autoGGUFModel = AutoGGUFModel.pretrained()
  .setInputCols("document")
  .setOutputCol("completions")

The default model is "phi3.5_mini_4k_instruct_q4_gguf", if no name is provided.

For available pretrained models please see the Models Hub.

For extended examples of usage, see the AutoGGUFModelTest and the example notebook.

Note

To use GPU inference with this annotator, make sure to use the Spark NLP GPU package and set the number of GPU layers with the setNGpuLayers method.

When using larger models, we recommend adjusting GPU usage with setNCtx and setNGpuLayers according to your hardware to avoid out-of-memory errors.

Example

import com.johnsnowlabs.nlp.base._
import com.johnsnowlabs.nlp.annotator._
import org.apache.spark.ml.Pipeline
import spark.implicits._

val document = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")

val autoGGUFModel = AutoGGUFModel
  .pretrained()
  .setInputCols("document")
  .setOutputCol("completions")
  .setBatchSize(4)
  .setNPredict(20)
  .setNGpuLayers(99)
  .setTemperature(0.4f)
  .setTopK(40)
  .setTopP(0.9f)
  .setPenalizeNl(true)

val pipeline = new Pipeline().setStages(Array(document, autoGGUFModel))

val data = Seq("Hello, I am a").toDF("text")
val result = pipeline.fit(data).transform(data)
result.select("completions").show(truncate = false)
+-----------------------------------------------------------------------------------------------------------------------------------+
|completions                                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------+
|[{document, 0, 78,  new user.  I am currently working on a project and I need to create a list of , {prompt -> Hello, I am a}, []}]|
+-----------------------------------------------------------------------------------------------------------------------------------+
Linear Supertypes
HasProtectedParams, HasLlamaCppProperties, HasEngine, HasBatchedAnnotate[AutoGGUFModel], AnnotatorModel[AutoGGUFModel], CanBeLazy, RawAnnotator[AutoGGUFModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[AutoGGUFModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AutoGGUFModel
  2. HasProtectedParams
  3. HasLlamaCppProperties
  4. HasEngine
  5. HasBatchedAnnotate
  6. AnnotatorModel
  7. CanBeLazy
  8. RawAnnotator
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. HasOutputAnnotatorType
  12. ParamsAndFeaturesWritable
  13. HasFeatures
  14. DefaultParamsWritable
  15. MLWritable
  16. Model
  17. Transformer
  18. PipelineStage
  19. Logging
  20. Params
  21. Serializable
  22. Serializable
  23. Identifiable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AutoGGUFModel()

    Annotator reference id.

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

  2. new AutoGGUFModel(uid: String)

    uid

    required uid for storing annotator to disk

Type Members

  1. implicit class ProtectedParam[T] extends Param[T]
    Definition Classes
    HasProtectedParams
  2. 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
  3. 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]]

    Completes the batch of annotations.

    Completes the batch of annotations.

    batchedAnnotations

    Annotations (single element arrays) in batches

    returns

    Completed text sequences

    Definition Classes
    AutoGGUFModel → 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. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  16. val cachePrompt: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  17. val chatTemplate: Param[String]

    Definition Classes
    HasLlamaCppProperties
  18. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  19. final def clear(param: Param[_]): AutoGGUFModel.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): AutoGGUFModel

    requirement for annotators copies

    requirement for annotators copies

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

    Definition Classes
    HasLlamaCppProperties
  25. val disableTokenIds: IntArrayParam

    Definition Classes
    HasLlamaCppProperties
  26. val dynamicTemperatureExponent: FloatParam

    Definition Classes
    HasLlamaCppProperties
  27. val dynamicTemperatureRange: FloatParam

    Definition Classes
    HasLlamaCppProperties
  28. val embedding: BooleanParam
    Definition Classes
    HasLlamaCppProperties
  29. 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
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  32. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  33. def explainParams(): String
    Definition Classes
    Params
  34. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  35. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  36. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  37. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  38. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  39. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  40. val flashAttention: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  41. val frequencyPenalty: FloatParam

    Definition Classes
    HasLlamaCppProperties
  42. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  44. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  45. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  46. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  47. def getBatchSize: Int

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  48. def getCachePrompt: Boolean

    Definition Classes
    HasLlamaCppProperties
  49. def getChatTemplate: String

    Definition Classes
    HasLlamaCppProperties
  50. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  52. def getDefragmentationThreshold: Float

    Definition Classes
    HasLlamaCppProperties
  53. def getDisableTokenIds: Array[Int]

    Definition Classes
    HasLlamaCppProperties
  54. def getDynamicTemperatureExponent: Float

    Definition Classes
    HasLlamaCppProperties
  55. def getDynamicTemperatureRange: Float

    Definition Classes
    HasLlamaCppProperties
  56. def getEmbedding: Boolean

    Definition Classes
    HasLlamaCppProperties
  57. def getEngine: String

    Definition Classes
    HasEngine
  58. def getFlashAttention: Boolean

    Definition Classes
    HasLlamaCppProperties
  59. def getFrequencyPenalty: Float

    Definition Classes
    HasLlamaCppProperties
  60. def getGrammar: String

    Definition Classes
    HasLlamaCppProperties
  61. def getGrpAttnN: Int
    Definition Classes
    HasLlamaCppProperties
  62. def getGrpAttnW: Int

    Definition Classes
    HasLlamaCppProperties
  63. def getIgnoreEos: Boolean

    Definition Classes
    HasLlamaCppProperties
  64. def getInferenceParameters: InferenceParameters
    Attributes
    protected
    Definition Classes
    HasLlamaCppProperties
  65. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  66. def getInputPrefix: String

    Definition Classes
    HasLlamaCppProperties
  67. def getInputPrefixBos: Boolean

    Definition Classes
    HasLlamaCppProperties
  68. def getInputSuffix: String

    Definition Classes
    HasLlamaCppProperties
  69. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  70. def getLookupCacheDynamicFilePath: String

    Definition Classes
    HasLlamaCppProperties
  71. def getLookupCacheStaticFilePath: String

    Definition Classes
    HasLlamaCppProperties
  72. def getLoraAdapters: Map[String, Float]

    Definition Classes
    HasLlamaCppProperties
  73. def getMainGpu: Int

    Definition Classes
    HasLlamaCppProperties
  74. def getMetadata: String

    Get the metadata for the model

    Get the metadata for the model

    Definition Classes
    HasLlamaCppProperties
  75. def getMetadataMap: Map[String, String]
  76. def getMinKeep: Int

    Definition Classes
    HasLlamaCppProperties
  77. def getMinP: Float

    Definition Classes
    HasLlamaCppProperties
  78. def getMiroStat: String

    Definition Classes
    HasLlamaCppProperties
  79. def getMiroStatEta: Float

    Definition Classes
    HasLlamaCppProperties
  80. def getMiroStatTau: Float

    Definition Classes
    HasLlamaCppProperties
  81. def getModelDraft: String

    Definition Classes
    HasLlamaCppProperties
  82. def getModelIfNotSet: GGUFWrapper

  83. def getModelParameters: ModelParameters
    Attributes
    protected
    Definition Classes
    HasLlamaCppProperties
  84. def getNBatch: Int

    Definition Classes
    HasLlamaCppProperties
  85. def getNChunks: Int

    Definition Classes
    HasLlamaCppProperties
  86. def getNCtx: Int

    Definition Classes
    HasLlamaCppProperties
  87. def getNDraft: Int

    Definition Classes
    HasLlamaCppProperties
  88. def getNGpuLayers: Int

    Definition Classes
    HasLlamaCppProperties
  89. def getNGpuLayersDraft: Int

    Definition Classes
    HasLlamaCppProperties
  90. def getNKeep: Int

    Definition Classes
    HasLlamaCppProperties
  91. def getNPredict: Int
    Definition Classes
    HasLlamaCppProperties
  92. def getNProbs: Int

    Definition Classes
    HasLlamaCppProperties
  93. def getNSequences: Int

    Definition Classes
    HasLlamaCppProperties
  94. def getNThreads: Int

    Definition Classes
    HasLlamaCppProperties
  95. def getNThreadsBatch: Int

    Definition Classes
    HasLlamaCppProperties
  96. def getNThreadsBatchDraft: Int

    Definition Classes
    HasLlamaCppProperties
  97. def getNThreadsDraft: Int

    Definition Classes
    HasLlamaCppProperties
  98. def getNUbatch: Int

    Definition Classes
    HasLlamaCppProperties
  99. def getNoKvOffload: Boolean

    Definition Classes
    HasLlamaCppProperties
  100. def getNuma: String

    Definition Classes
    HasLlamaCppProperties
  101. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  102. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  103. def getPSplit: Float

    Definition Classes
    HasLlamaCppProperties
  104. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  105. def getPenalizeNl: Boolean

    Definition Classes
    HasLlamaCppProperties
  106. def getPenaltyPrompt: String

    Definition Classes
    HasLlamaCppProperties
  107. def getPoolingType: String

    Definition Classes
    HasLlamaCppProperties
  108. def getPresencePenalty: Float

    Definition Classes
    HasLlamaCppProperties
  109. def getRepeatLastN: Int

    Definition Classes
    HasLlamaCppProperties
  110. def getRepeatPenalty: Float

    Definition Classes
    HasLlamaCppProperties
  111. def getRopeFreqBase: Float

    Definition Classes
    HasLlamaCppProperties
  112. def getRopeFreqScale: Float

    Definition Classes
    HasLlamaCppProperties
  113. def getRopeScalingType: String

    Definition Classes
    HasLlamaCppProperties
  114. def getSamplers: Array[String]

    Definition Classes
    HasLlamaCppProperties
  115. def getSeed: Int

    Definition Classes
    HasLlamaCppProperties
  116. def getSplitMode: String

    Definition Classes
    HasLlamaCppProperties
  117. def getStopStrings: Array[String]

    Definition Classes
    HasLlamaCppProperties
  118. def getSystemPrompt: String

    Definition Classes
    HasLlamaCppProperties
  119. def getTemperature: Float

    Definition Classes
    HasLlamaCppProperties
  120. def getTensorSplit: Array[Double]

    Definition Classes
    HasLlamaCppProperties
  121. def getTfsZ: Float

    Definition Classes
    HasLlamaCppProperties
  122. def getTokenBias: Map[String, Float]

    Definition Classes
    HasLlamaCppProperties
  123. def getTokenIdBias: Map[Int, Float]

    Definition Classes
    HasLlamaCppProperties
  124. def getTopK: Int

    Definition Classes
    HasLlamaCppProperties
  125. def getTopP: Float

    Definition Classes
    HasLlamaCppProperties
  126. def getTypicalP: Float

    Definition Classes
    HasLlamaCppProperties
  127. def getUseChatTemplate: Boolean

    Definition Classes
    HasLlamaCppProperties
  128. def getUseMlock: Boolean

    Definition Classes
    HasLlamaCppProperties
  129. def getUseMmap: Boolean

    Definition Classes
    HasLlamaCppProperties
  130. def getYarnAttnFactor: Float

    Definition Classes
    HasLlamaCppProperties
  131. def getYarnBetaFast: Float

    Definition Classes
    HasLlamaCppProperties
  132. def getYarnBetaSlow: Float

    Definition Classes
    HasLlamaCppProperties
  133. def getYarnExtFactor: Float

    Definition Classes
    HasLlamaCppProperties
  134. def getYarnOrigCtx: Int

    Definition Classes
    HasLlamaCppProperties
  135. val gpuSplitMode: Param[String]

    Set how to split the model across GPUs

    Set how to split the model across GPUs

    • NONE: No GPU split
    • LAYER: Split the model across GPUs by layer
    • ROW: Split the model across GPUs by rows
    Definition Classes
    HasLlamaCppProperties
  136. val grammar: Param[String]

    Definition Classes
    HasLlamaCppProperties
  137. val grpAttnN: IntParam

    Definition Classes
    HasLlamaCppProperties
  138. val grpAttnW: IntParam

    Definition Classes
    HasLlamaCppProperties
  139. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  140. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  141. def hasParent: Boolean
    Definition Classes
    Model
  142. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  143. val ignoreEos: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  144. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  145. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  146. val inputAnnotatorTypes: Array[AnnotatorType]

    Annotator reference id.

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

    Definition Classes
    AutoGGUFModel → HasInputAnnotationCols
  147. 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
  148. val inputPrefix: Param[String]

    Definition Classes
    HasLlamaCppProperties
  149. val inputPrefixBos: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  150. val inputSuffix: Param[String]

    Definition Classes
    HasLlamaCppProperties
  151. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  152. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  153. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  154. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  155. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  156. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  157. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  158. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  159. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  160. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  161. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  162. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  163. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  164. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  165. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  166. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  167. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  168. val logger: Logger
    Definition Classes
    HasLlamaCppProperties
  169. val lookupCacheDynamicFilePath: Param[String]

    Definition Classes
    HasLlamaCppProperties
  170. val lookupCacheStaticFilePath: Param[String]

    Definition Classes
    HasLlamaCppProperties
  171. val loraAdapters: StructFeature[Map[String, Float]]

    Definition Classes
    HasLlamaCppProperties
  172. val mainGpu: IntParam

    Definition Classes
    HasLlamaCppProperties
  173. val metadata: ProtectedParam[String]
    Definition Classes
    HasLlamaCppProperties
  174. val minKeep: IntParam

    Definition Classes
    HasLlamaCppProperties
  175. val minP: FloatParam

    Definition Classes
    HasLlamaCppProperties
  176. val miroStat: Param[String]

    Definition Classes
    HasLlamaCppProperties
  177. val miroStatEta: FloatParam

    Definition Classes
    HasLlamaCppProperties
  178. val miroStatTau: FloatParam

    Definition Classes
    HasLlamaCppProperties
  179. val modelDraft: Param[String]

    Definition Classes
    HasLlamaCppProperties
  180. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  181. val nBatch: IntParam

    Definition Classes
    HasLlamaCppProperties
  182. val nChunks: IntParam

    Definition Classes
    HasLlamaCppProperties
  183. val nCtx: IntParam

    Definition Classes
    HasLlamaCppProperties
  184. val nDraft: IntParam

    Definition Classes
    HasLlamaCppProperties
  185. val nGpuLayers: IntParam

    Definition Classes
    HasLlamaCppProperties
  186. val nGpuLayersDraft: IntParam

    Definition Classes
    HasLlamaCppProperties
  187. val nKeep: IntParam

    Definition Classes
    HasLlamaCppProperties
  188. val nPredict: IntParam

    Definition Classes
    HasLlamaCppProperties
  189. val nProbs: IntParam

    Definition Classes
    HasLlamaCppProperties
  190. val nSequences: IntParam

    Definition Classes
    HasLlamaCppProperties
  191. val nThreads: IntParam

    Definition Classes
    HasLlamaCppProperties
  192. val nThreadsBatch: IntParam

    Definition Classes
    HasLlamaCppProperties
  193. val nThreadsBatchDraft: IntParam

    Definition Classes
    HasLlamaCppProperties
  194. val nThreadsDraft: IntParam

    Definition Classes
    HasLlamaCppProperties
  195. val nUbatch: IntParam

    Definition Classes
    HasLlamaCppProperties
  196. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  197. val noKvOffload: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  198. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  199. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  200. val numaStrategy: Param[String]

    Set optimization strategies that help on some NUMA systems (if available)

    Set optimization strategies that help on some NUMA systems (if available)

    Available Strategies:

    • DISABLED: No NUMA optimizations
    • DISTRIBUTE: Spread execution evenly over all
    • ISOLATE: Only spawn threads on CPUs on the node that execution started on
    • NUMA_CTL: Use the CPU map provided by numactl
    • MIRROR: Mirrors the model across NUMA nodes
    Definition Classes
    HasLlamaCppProperties
  201. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    AutoGGUFModel → ParamsAndFeaturesWritable
  202. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  203. val outputAnnotatorType: AnnotatorType
    Definition Classes
    AutoGGUFModel → HasOutputAnnotatorType
  204. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  205. val pSplit: FloatParam

    Definition Classes
    HasLlamaCppProperties
  206. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  207. var parent: Estimator[AutoGGUFModel]
    Definition Classes
    Model
  208. val penalizeNl: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  209. val penaltyPrompt: Param[String]

    Definition Classes
    HasLlamaCppProperties
  210. val poolingType: Param[String]

    Set the pooling type for embeddings, use model default if unspecified

    Set the pooling type for embeddings, use model default if unspecified

    • 0 UNSPECIFIED: Don't use any pooling
    • 1 MEAN: Mean Pooling
    • 2 CLS: CLS Pooling
    Definition Classes
    HasLlamaCppProperties
  211. val presencePenalty: FloatParam

    Definition Classes
    HasLlamaCppProperties
  212. val repeatLastN: IntParam

    Definition Classes
    HasLlamaCppProperties
  213. val repeatPenalty: FloatParam

    Definition Classes
    HasLlamaCppProperties
  214. val ropeFreqBase: FloatParam

    Definition Classes
    HasLlamaCppProperties
  215. val ropeFreqScale: FloatParam

    Definition Classes
    HasLlamaCppProperties
  216. val ropeScalingType: Param[String]

    Set the RoPE frequency scaling method, defaults to linear unless specified by the model.

    Set the RoPE frequency scaling method, defaults to linear unless specified by the model.

    • UNSPECIFIED: Don't use any scaling
    • LINEAR: Linear scaling
    • YARN: YaRN RoPE scaling
    Definition Classes
    HasLlamaCppProperties
  217. val samplers: StringArrayParam

    Definition Classes
    HasLlamaCppProperties
  218. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  219. val seed: IntParam

    Definition Classes
    HasLlamaCppProperties
  220. def set[T](param: ProtectedParam[T], value: T): AutoGGUFModel.this.type

    Sets the value for a protected Param.

    Sets the value for a protected Param.

    If the parameter was already set, it will not be set again. Default values do not count as a set value and can be overridden.

    T

    Type of the parameter

    param

    Protected parameter to set

    value

    Value for the parameter

    returns

    This object

    Definition Classes
    HasProtectedParams
  221. def set[T](feature: StructFeature[T], value: T): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  222. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  223. def set[T](feature: SetFeature[T], value: Set[T]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  224. def set[T](feature: ArrayFeature[T], value: Array[T]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  225. final def set(paramPair: ParamPair[_]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  226. final def set(param: String, value: Any): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  227. final def set[T](param: Param[T], value: T): AutoGGUFModel.this.type
    Definition Classes
    Params
  228. def setBatchSize(size: Int): AutoGGUFModel.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  229. def setCachePrompt(cachePrompt: Boolean): AutoGGUFModel.this.type

    Whether to remember the prompt to avoid reprocessing it

    Whether to remember the prompt to avoid reprocessing it

    Definition Classes
    HasLlamaCppProperties
  230. def setChatTemplate(chatTemplate: String): AutoGGUFModel.this.type

    The chat template to use

    The chat template to use

    Definition Classes
    HasLlamaCppProperties
  231. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  232. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  233. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  234. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  235. final def setDefault(paramPairs: ParamPair[_]*): AutoGGUFModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  236. final def setDefault[T](param: Param[T], value: T): AutoGGUFModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  237. def setDefragmentationThreshold(defragThold: Float): AutoGGUFModel.this.type

    Set the KV cache defragmentation threshold

    Set the KV cache defragmentation threshold

    Definition Classes
    HasLlamaCppProperties
  238. def setDisableTokenIds(disableTokenIds: Array[Int]): AutoGGUFModel.this.type

    Set the token ids to disable in the completion.

    Set the token ids to disable in the completion. This corresponds to setTokenBias with a value of Float.NEGATIVE_INFINITY.

    Definition Classes
    HasLlamaCppProperties
  239. def setDynamicTemperatureExponent(dynatempExponent: Float): AutoGGUFModel.this.type

    Set the dynamic temperature exponent

    Set the dynamic temperature exponent

    Definition Classes
    HasLlamaCppProperties
  240. def setDynamicTemperatureRange(dynatempRange: Float): AutoGGUFModel.this.type

    Set the dynamic temperature range

    Set the dynamic temperature range

    Definition Classes
    HasLlamaCppProperties
  241. def setEmbedding(embedding: Boolean): AutoGGUFModel.this.type

    Whether to load model with embedding support

    Whether to load model with embedding support

    Definition Classes
    HasLlamaCppProperties
  242. def setFlashAttention(flashAttention: Boolean): AutoGGUFModel.this.type

    Whether to enable Flash Attention

    Whether to enable Flash Attention

    Definition Classes
    HasLlamaCppProperties
  243. def setFrequencyPenalty(frequencyPenalty: Float): AutoGGUFModel.this.type

    Set the repetition alpha frequency penalty

    Set the repetition alpha frequency penalty

    Definition Classes
    HasLlamaCppProperties
  244. def setGpuSplitMode(splitMode: String): AutoGGUFModel.this.type

    Set how to split the model across GPUs

    Set how to split the model across GPUs

    • NONE: No GPU split -LAYER: Split the model across GPUs by layer 2. ROW: Split the model across GPUs by rows
    Definition Classes
    HasLlamaCppProperties
  245. def setGrammar(grammar: String): AutoGGUFModel.this.type

    Set BNF-like grammar to constrain generations

    Set BNF-like grammar to constrain generations

    Definition Classes
    HasLlamaCppProperties
  246. def setGrpAttnN(grpAttnN: Int): AutoGGUFModel.this.type

    Set the group-attention factor

    Set the group-attention factor

    Definition Classes
    HasLlamaCppProperties
  247. def setGrpAttnW(grpAttnW: Int): AutoGGUFModel.this.type

    Set the group-attention width

    Set the group-attention width

    Definition Classes
    HasLlamaCppProperties
  248. def setIgnoreEos(ignoreEos: Boolean): AutoGGUFModel.this.type

    Set whether to ignore end of stream token and continue generating (implies --logit-bias 2-inf)

    Set whether to ignore end of stream token and continue generating (implies --logit-bias 2-inf)

    Definition Classes
    HasLlamaCppProperties
  249. final def setInputCols(value: String*): AutoGGUFModel.this.type
    Definition Classes
    HasInputAnnotationCols
  250. def setInputCols(value: Array[String]): AutoGGUFModel.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  251. def setInputPrefix(inputPrefix: String): AutoGGUFModel.this.type

    Set the prompt to start generation with

    Set the prompt to start generation with

    Definition Classes
    HasLlamaCppProperties
  252. def setInputPrefixBos(inputPrefixBos: Boolean): AutoGGUFModel.this.type

    Whether to add prefix BOS to user inputs, preceding the --in-prefix string

    Whether to add prefix BOS to user inputs, preceding the --in-prefix string

    Definition Classes
    HasLlamaCppProperties
  253. def setInputSuffix(inputSuffix: String): AutoGGUFModel.this.type

    Set a suffix for infilling

    Set a suffix for infilling

    Definition Classes
    HasLlamaCppProperties
  254. def setLazyAnnotator(value: Boolean): AutoGGUFModel.this.type
    Definition Classes
    CanBeLazy
  255. def setLookupCacheDynamicFilePath(lookupCacheDynamicFilePath: String): AutoGGUFModel.this.type

    Set a model alias

    Set a model alias

    Definition Classes
    HasLlamaCppProperties
  256. def setLookupCacheStaticFilePath(lookupCacheStaticFilePath: String): AutoGGUFModel.this.type

    Set a model alias

    Set a model alias

    Definition Classes
    HasLlamaCppProperties
  257. def setLoraAdapters(loraAdapters: HashMap[String, Double]): AutoGGUFModel.this.type

    Sets paths to lora adapters with user defined scale.

    Sets paths to lora adapters with user defined scale. (PySpark Override)

    Definition Classes
    HasLlamaCppProperties
  258. def setLoraAdapters(loraAdapters: Map[String, Float]): AutoGGUFModel.this.type

    Sets paths to lora adapters with user defined scale.

    Sets paths to lora adapters with user defined scale.

    Definition Classes
    HasLlamaCppProperties
  259. def setMainGpu(mainGpu: Int): AutoGGUFModel.this.type

    Set the GPU that is used for scratch and small tensors

    Set the GPU that is used for scratch and small tensors

    Definition Classes
    HasLlamaCppProperties
  260. def setMetadata(metadata: String): AutoGGUFModel.this.type

    Set the metadata for the model

    Set the metadata for the model

    Definition Classes
    HasLlamaCppProperties
  261. def setMinKeep(minKeep: Int): AutoGGUFModel.this.type

    Set the amount of tokens the samplers should return at least (0 = disabled)

    Set the amount of tokens the samplers should return at least (0 = disabled)

    Definition Classes
    HasLlamaCppProperties
  262. def setMinP(minP: Float): AutoGGUFModel.this.type

    Set min-p sampling

    Set min-p sampling

    Definition Classes
    HasLlamaCppProperties
  263. def setMiroStat(mirostat: String): AutoGGUFModel.this.type

    Set MiroStat sampling strategies.

    Set MiroStat sampling strategies.

    • DISABLED: No MiroStat
    • V1: MiroStat V1
    • V2: MiroStat V2
    Definition Classes
    HasLlamaCppProperties
  264. def setMiroStatEta(mirostatEta: Float): AutoGGUFModel.this.type

    Set the MiroStat learning rate, parameter eta

    Set the MiroStat learning rate, parameter eta

    Definition Classes
    HasLlamaCppProperties
  265. def setMiroStatTau(mirostatTau: Float): AutoGGUFModel.this.type

    Set the MiroStat target entropy, parameter tau

    Set the MiroStat target entropy, parameter tau

    Definition Classes
    HasLlamaCppProperties
  266. def setModelDraft(modelDraft: String): AutoGGUFModel.this.type

    Set the draft model for speculative decoding

    Set the draft model for speculative decoding

    Definition Classes
    HasLlamaCppProperties
  267. def setModelIfNotSet(spark: SparkSession, wrapper: GGUFWrapper): AutoGGUFModel.this.type

  268. def setNBatch(nBatch: Int): AutoGGUFModel.this.type

    Set the logical batch size for prompt processing (must be >=32 to use BLAS)

    Set the logical batch size for prompt processing (must be >=32 to use BLAS)

    Definition Classes
    HasLlamaCppProperties
  269. def setNChunks(nChunks: Int): AutoGGUFModel.this.type

    Set the maximal number of chunks to process

    Set the maximal number of chunks to process

    Definition Classes
    HasLlamaCppProperties
  270. def setNCtx(nCtx: Int): AutoGGUFModel.this.type

    Set the size of the prompt context

    Set the size of the prompt context

    Definition Classes
    HasLlamaCppProperties
  271. def setNDraft(nDraft: Int): AutoGGUFModel.this.type

    Set the number of tokens to draft for speculative decoding

    Set the number of tokens to draft for speculative decoding

    Definition Classes
    HasLlamaCppProperties
  272. def setNGpuLayers(nGpuLayers: Int): AutoGGUFModel.this.type

    Set the number of layers to store in VRAM (-1 - use default)

    Set the number of layers to store in VRAM (-1 - use default)

    Definition Classes
    HasLlamaCppProperties
  273. def setNGpuLayersDraft(nGpuLayersDraft: Int): AutoGGUFModel.this.type

    Set the number of layers to store in VRAM for the draft model (-1 - use default)

    Set the number of layers to store in VRAM for the draft model (-1 - use default)

    Definition Classes
    HasLlamaCppProperties
  274. def setNKeep(nKeep: Int): AutoGGUFModel.this.type

    Set the number of tokens to keep from the initial prompt

    Set the number of tokens to keep from the initial prompt

    Definition Classes
    HasLlamaCppProperties
  275. def setNPredict(nPredict: Int): AutoGGUFModel.this.type

    Set the number of tokens to predict

    Set the number of tokens to predict

    Definition Classes
    HasLlamaCppProperties
  276. def setNProbs(nProbs: Int): AutoGGUFModel.this.type

    Set the amount top tokens probabilities to output if greater than 0.

    Set the amount top tokens probabilities to output if greater than 0.

    Definition Classes
    HasLlamaCppProperties
  277. def setNSequences(nSequences: Int): AutoGGUFModel.this.type

    Set the number of sequences to decode

    Set the number of sequences to decode

    Definition Classes
    HasLlamaCppProperties
  278. def setNThreads(nThreads: Int): AutoGGUFModel.this.type

    Set the number of threads to use during generation

    Set the number of threads to use during generation

    Definition Classes
    HasLlamaCppProperties
  279. def setNThreadsBatch(nThreadsBatch: Int): AutoGGUFModel.this.type

    Set the number of threads to use during batch and prompt processing

    Set the number of threads to use during batch and prompt processing

    Definition Classes
    HasLlamaCppProperties
  280. def setNThreadsBatchDraft(nThreadsBatchDraft: Int): AutoGGUFModel.this.type

    Set the number of threads to use during batch and prompt processing

    Set the number of threads to use during batch and prompt processing

    Definition Classes
    HasLlamaCppProperties
  281. def setNThreadsDraft(nThreadsDraft: Int): AutoGGUFModel.this.type

    Set the number of threads to use during draft generation

    Set the number of threads to use during draft generation

    Definition Classes
    HasLlamaCppProperties
  282. def setNUbatch(nUbatch: Int): AutoGGUFModel.this.type

    Set the physical batch size for prompt processing (must be >=32 to use BLAS)

    Set the physical batch size for prompt processing (must be >=32 to use BLAS)

    Definition Classes
    HasLlamaCppProperties
  283. def setNoKvOffload(noKvOffload: Boolean): AutoGGUFModel.this.type

    Whether to disable KV offload

    Whether to disable KV offload

    Definition Classes
    HasLlamaCppProperties
  284. def setNumaStrategy(numa: String): AutoGGUFModel.this.type

    Set optimization strategies that help on some NUMA systems (if available)

    Set optimization strategies that help on some NUMA systems (if available)

    Available Strategies:

    • DISABLED: No NUMA optimizations
    • DISTRIBUTE: spread execution evenly over all
    • ISOLATE: only spawn threads on CPUs on the node that execution started on
    • NUMA_CTL: use the CPU map provided by numactl
    • MIRROR: Mirrors the model across NUMA nodes
    Definition Classes
    HasLlamaCppProperties
  285. final def setOutputCol(value: String): AutoGGUFModel.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  286. def setPSplit(pSplit: Float): AutoGGUFModel.this.type

    Set the speculative decoding split probability

    Set the speculative decoding split probability

    Definition Classes
    HasLlamaCppProperties
  287. def setParent(parent: Estimator[AutoGGUFModel]): AutoGGUFModel
    Definition Classes
    Model
  288. def setPenalizeNl(penalizeNl: Boolean): AutoGGUFModel.this.type

    Set whether to penalize newline tokens

    Set whether to penalize newline tokens

    Definition Classes
    HasLlamaCppProperties
  289. def setPenaltyPrompt(penaltyPrompt: String): AutoGGUFModel.this.type

    Override which part of the prompt is penalized for repetition.

    Override which part of the prompt is penalized for repetition.

    Definition Classes
    HasLlamaCppProperties
  290. def setPoolingType(poolingType: String): AutoGGUFModel.this.type

    Set the pooling type for embeddings, use model default if unspecified

    Set the pooling type for embeddings, use model default if unspecified

    • UNSPECIFIED: Don't use any pooling
    • MEAN: Mean Pooling
    • CLS: CLS Pooling
    Definition Classes
    HasLlamaCppProperties
  291. def setPresencePenalty(presencePenalty: Float): AutoGGUFModel.this.type

    Set the repetition alpha presence penalty

    Set the repetition alpha presence penalty

    Definition Classes
    HasLlamaCppProperties
  292. def setRepeatLastN(repeatLastN: Int): AutoGGUFModel.this.type

    Set the last n tokens to consider for penalties

    Set the last n tokens to consider for penalties

    Definition Classes
    HasLlamaCppProperties
  293. def setRepeatPenalty(repeatPenalty: Float): AutoGGUFModel.this.type

    Set the penalty of repeated sequences of tokens

    Set the penalty of repeated sequences of tokens

    Definition Classes
    HasLlamaCppProperties
  294. def setRopeFreqBase(ropeFreqBase: Float): AutoGGUFModel.this.type

    Set the RoPE base frequency, used by NTK-aware scaling

    Set the RoPE base frequency, used by NTK-aware scaling

    Definition Classes
    HasLlamaCppProperties
  295. def setRopeFreqScale(ropeFreqScale: Float): AutoGGUFModel.this.type

    Set the RoPE frequency scaling factor, expands context by a factor of 1/N

    Set the RoPE frequency scaling factor, expands context by a factor of 1/N

    Definition Classes
    HasLlamaCppProperties
  296. def setRopeScalingType(ropeScalingType: String): AutoGGUFModel.this.type

    Set the RoPE frequency scaling method, defaults to linear unless specified by the model.

    Set the RoPE frequency scaling method, defaults to linear unless specified by the model.

    • UNSPECIFIED: Don't use any scaling
    • LINEAR: Linear scaling
    • YARN: YaRN RoPE scaling
    Definition Classes
    HasLlamaCppProperties
  297. def setSamplers(samplers: Array[String]): AutoGGUFModel.this.type

    Set which samplers to use for token generation in the given order .

    Set which samplers to use for token generation in the given order .

    Available Samplers are:

    • TOP_K: Top-k sampling
    • TFS_Z: Tail free sampling
    • TYPICAL_P: Locally typical sampling p
    • TOP_P: Top-p sampling
    • MIN_P: Min-p sampling
    • TEMPERATURE: Temperature sampling
    Definition Classes
    HasLlamaCppProperties
  298. def setSeed(seed: Int): AutoGGUFModel.this.type

    Set the RNG seed

    Set the RNG seed

    Definition Classes
    HasLlamaCppProperties
  299. def setStopStrings(stopStrings: Array[String]): AutoGGUFModel.this.type

    Set strings upon seeing which token generation is stopped

    Set strings upon seeing which token generation is stopped

    Definition Classes
    HasLlamaCppProperties
  300. def setSystemPrompt(systemPrompt: String): AutoGGUFModel.this.type

    Set a system prompt to use

    Set a system prompt to use

    Definition Classes
    HasLlamaCppProperties
  301. def setTemperature(temperature: Float): AutoGGUFModel.this.type

    Set the temperature

    Set the temperature

    Definition Classes
    HasLlamaCppProperties
  302. def setTensorSplit(tensorSplit: Array[Double]): AutoGGUFModel.this.type

    Set how split tensors should be distributed across GPUs

    Set how split tensors should be distributed across GPUs

    Definition Classes
    HasLlamaCppProperties
  303. def setTfsZ(tfsZ: Float): AutoGGUFModel.this.type

    Set tail free sampling, parameter z

    Set tail free sampling, parameter z

    Definition Classes
    HasLlamaCppProperties
  304. def setTokenBias(tokenBias: HashMap[String, Double]): AutoGGUFModel.this.type

    Set the tokens to disable during completion.

    Set the tokens to disable during completion. (Override for PySpark)

    Definition Classes
    HasLlamaCppProperties
  305. def setTokenBias(tokenBias: Map[String, Float]): AutoGGUFModel.this.type

    Set the tokens to disable during completion.

    Set the tokens to disable during completion.

    Definition Classes
    HasLlamaCppProperties
  306. def setTokenIdBias(tokenIdBias: HashMap[Integer, Double]): AutoGGUFModel.this.type

    Set the token ids to disable in the completion.

    Set the token ids to disable in the completion. (Override for PySpark)

    Definition Classes
    HasLlamaCppProperties
  307. def setTokenIdBias(tokenIdBias: Map[Int, Float]): AutoGGUFModel.this.type

    Set the token ids to disable in the completion.

    Set the token ids to disable in the completion.

    Definition Classes
    HasLlamaCppProperties
  308. def setTopK(topK: Int): AutoGGUFModel.this.type

    Set top-k sampling

    Set top-k sampling

    Definition Classes
    HasLlamaCppProperties
  309. def setTopP(topP: Float): AutoGGUFModel.this.type

    Set top-p sampling

    Set top-p sampling

    Definition Classes
    HasLlamaCppProperties
  310. def setTypicalP(typicalP: Float): AutoGGUFModel.this.type

    Set locally typical sampling, parameter p

    Set locally typical sampling, parameter p

    Definition Classes
    HasLlamaCppProperties
  311. def setUseChatTemplate(useChatTemplate: Boolean): AutoGGUFModel.this.type

    Set whether or not generate should apply a chat template

    Set whether or not generate should apply a chat template

    Definition Classes
    HasLlamaCppProperties
  312. def setUseMlock(useMlock: Boolean): AutoGGUFModel.this.type

    Whether to force the system to keep model in RAM rather than swapping or compressing

    Whether to force the system to keep model in RAM rather than swapping or compressing

    Definition Classes
    HasLlamaCppProperties
  313. def setUseMmap(useMmap: Boolean): AutoGGUFModel.this.type

    Whether to use memory-map model (faster load but may increase pageouts if not using mlock)

    Whether to use memory-map model (faster load but may increase pageouts if not using mlock)

    Definition Classes
    HasLlamaCppProperties
  314. def setYarnAttnFactor(yarnAttnFactor: Float): AutoGGUFModel.this.type

    Set the YaRN scale sqrt(t) or attention magnitude

    Set the YaRN scale sqrt(t) or attention magnitude

    Definition Classes
    HasLlamaCppProperties
  315. def setYarnBetaFast(yarnBetaFast: Float): AutoGGUFModel.this.type

    Set the YaRN low correction dim or beta

    Set the YaRN low correction dim or beta

    Definition Classes
    HasLlamaCppProperties
  316. def setYarnBetaSlow(yarnBetaSlow: Float): AutoGGUFModel.this.type

    Set the YaRN high correction dim or alpha

    Set the YaRN high correction dim or alpha

    Definition Classes
    HasLlamaCppProperties
  317. def setYarnExtFactor(yarnExtFactor: Float): AutoGGUFModel.this.type

    Set the YaRN extrapolation mix factor

    Set the YaRN extrapolation mix factor

    Definition Classes
    HasLlamaCppProperties
  318. def setYarnOrigCtx(yarnOrigCtx: Int): AutoGGUFModel.this.type

    Set the YaRN original context size of model

    Set the YaRN original context size of model

    Definition Classes
    HasLlamaCppProperties
  319. val stopStrings: StringArrayParam

    Definition Classes
    HasLlamaCppProperties
  320. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  321. val systemPrompt: Param[String]

    Definition Classes
    HasLlamaCppProperties
  322. val temperature: FloatParam

    Definition Classes
    HasLlamaCppProperties
  323. val tensorSplit: DoubleArrayParam

    Definition Classes
    HasLlamaCppProperties
  324. val tfsZ: FloatParam

    Definition Classes
    HasLlamaCppProperties
  325. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  326. val tokenBias: StructFeature[Map[String, Float]]

    Definition Classes
    HasLlamaCppProperties
  327. val tokenIdBias: StructFeature[Map[Int, Float]]
    Definition Classes
    HasLlamaCppProperties
  328. val topK: IntParam

    Definition Classes
    HasLlamaCppProperties
  329. val topP: FloatParam

    Definition Classes
    HasLlamaCppProperties
  330. 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
  331. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  332. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  333. 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
  334. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  335. val typicalP: FloatParam

    Definition Classes
    HasLlamaCppProperties
  336. val uid: String
    Definition Classes
    AutoGGUFModel → Identifiable
  337. val useChatTemplate: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  338. val useMlock: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  339. val useMmap: BooleanParam

    Definition Classes
    HasLlamaCppProperties
  340. 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
  341. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  342. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  343. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  344. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  345. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  346. val yarnAttnFactor: FloatParam

    Definition Classes
    HasLlamaCppProperties
  347. val yarnBetaFast: FloatParam

    Definition Classes
    HasLlamaCppProperties
  348. val yarnBetaSlow: FloatParam

    Definition Classes
    HasLlamaCppProperties
  349. val yarnExtFactor: FloatParam

    Definition Classes
    HasLlamaCppProperties
  350. val yarnOrigCtx: IntParam

    Definition Classes
    HasLlamaCppProperties

Inherited from HasProtectedParams

Inherited from HasLlamaCppProperties

Inherited from HasEngine

Inherited from HasBatchedAnnotate[AutoGGUFModel]

Inherited from AnnotatorModel[AutoGGUFModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[AutoGGUFModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[AutoGGUFModel]

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