Packages

class ImageFeaturizer extends Transformer with HasInputCol with HasOutputCol with Wrappable with ComplexParamsWritable with BasicLogging

The ImageFeaturizer relies on a ONNX model to do the featurization. One can set this model using the setOnnxModel parameter with a model you create yourself, or setModel to get a predefined named model from the ONNXHub.

The ImageFeaturizer takes an input column of images (the type returned by the ImageReader), and automatically resizes them to fit the ONNXModel's inputs. It then feeds them through a pre-trained ONNX model.

Linear Supertypes
BasicLogging, ComplexParamsWritable, MLWritable, Wrappable, DotnetWrappable, RWrappable, PythonWrappable, BaseWrappable, HasOutputCol, HasInputCol, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ImageFeaturizer
  2. BasicLogging
  3. ComplexParamsWritable
  4. MLWritable
  5. Wrappable
  6. DotnetWrappable
  7. RWrappable
  8. PythonWrappable
  9. BaseWrappable
  10. HasOutputCol
  11. HasInputCol
  12. Transformer
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    the uid of the image transformer

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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val channelNormalizationMeans: DoubleArrayParam
  7. val channelNormalizationStds: DoubleArrayParam
  8. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  9. final def clear(param: Param[_]): ImageFeaturizer.this.type
    Definition Classes
    Params
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. val colorScaleFactor: DoubleParam
  12. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  13. val convertFeaturesToVector: (Seq[Seq[Seq[Float]]]) ⇒ DenseVector
  14. val convertOutputToVector: (Seq[Float]) ⇒ DenseVector
  15. def copy(extra: ParamMap): Transformer
    Definition Classes
    ImageFeaturizer → Transformer → PipelineStage → Params
  16. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  18. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  20. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  33. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  34. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  35. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  36. val dropNa: BooleanParam
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  40. def explainParams(): String
    Definition Classes
    Params
  41. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  42. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  43. val featureTensorName: Param[String]

    Name of the output node which represents features

  44. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getChannelNormalizationMeans: Array[Double]

  47. def getChannelNormalizationStds: Array[Double]

  48. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def getColorScaleFactor: Double

  50. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  51. def getDropNa: Boolean

  52. def getFeatureTensorName: String

  53. def getHeadless: Boolean

  54. def getImageHeight: Int

  55. def getImageTensorName: String

  56. def getImageWidth: Int

  57. def getInputCol: String

    Definition Classes
    HasInputCol
  58. def getMiniBatchSize: Int

  59. def getModel: Array[Byte]

  60. def getOnnxModel: ONNXModel

  61. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  62. def getOutputCol: String

    Definition Classes
    HasOutputCol
  63. def getOutputTensorName: String

  64. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  65. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  66. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  67. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  68. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  69. val headless: BooleanParam
  70. val imageHeight: IntParam
  71. val imageTensorName: Param[String]

    Name of the input node for images

  72. val imageWidth: IntParam
  73. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  74. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. val inputCol: Param[String]

    The name of the input column

    The name of the input column

    Definition Classes
    HasInputCol
  76. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  77. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  78. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  79. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  80. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  81. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  82. def logClass(): Unit
    Definition Classes
    BasicLogging
  83. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  88. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  89. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  92. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  93. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  96. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  97. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  98. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  99. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  101. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  102. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  103. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  104. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  105. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  106. val onnxModel: TransformerParam
  107. val outputCol: Param[String]

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol
  108. val outputTensorName: Param[String]

    Name of the output node which represents probabilities

  109. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  110. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  111. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  112. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  113. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  114. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  117. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    ImageFeaturizer → PythonWrappable
  118. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  119. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  120. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  121. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  122. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  123. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  124. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  125. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  126. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  127. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  128. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  129. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  130. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  131. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  132. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  133. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  134. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  135. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  136. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  137. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  138. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  139. final def set(paramPair: ParamPair[_]): ImageFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  140. final def set(param: String, value: Any): ImageFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  141. final def set[T](param: Param[T], value: T): ImageFeaturizer.this.type
    Definition Classes
    Params
  142. def setChannelNormalizationMeans(value: Array[Double]): ImageFeaturizer.this.type

  143. def setChannelNormalizationStds(value: Array[Double]): ImageFeaturizer.this.type

  144. def setColorScaleFactor(value: Double): ImageFeaturizer.this.type

  145. final def setDefault(paramPairs: ParamPair[_]*): ImageFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  146. final def setDefault[T](param: Param[T], value: T): ImageFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  147. def setDropNa(value: Boolean): ImageFeaturizer.this.type

  148. def setFeatureTensorName(value: String): ImageFeaturizer.this.type

  149. def setHeadless(value: Boolean): ImageFeaturizer.this.type

  150. def setImageHeight(value: Int): ImageFeaturizer.this.type

  151. def setImageTensorName(value: String): ImageFeaturizer.this.type

  152. def setImageWidth(value: Int): ImageFeaturizer.this.type

  153. def setInputCol(value: String): ImageFeaturizer.this.type

    Definition Classes
    HasInputCol
  154. def setMiniBatchSize(value: Int): ImageFeaturizer.this.type

  155. def setModel(bytes: Array[Byte]): ImageFeaturizer.this.type

  156. def setModel(name: String): ImageFeaturizer.this.type
  157. def setModelInfo(info: ONNXModelInfo): ImageFeaturizer.this.type
  158. def setModelLocation(path: String): ImageFeaturizer.this.type
  159. def setOnnxModel(value: ONNXModel): ImageFeaturizer.this.type

  160. def setOutputCol(value: String): ImageFeaturizer.this.type

    Definition Classes
    HasOutputCol
  161. def setOutputTensorName(value: String): ImageFeaturizer.this.type

  162. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  163. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  164. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  165. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    ImageFeaturizer → Transformer
  166. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  167. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  168. def transformSchema(schema: StructType): StructType

    Add the features column to the schema

    Add the features column to the schema

    schema

    Schema to transform

    returns

    schema with features column

    Definition Classes
    ImageFeaturizer → PipelineStage
  169. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  170. val uid: String
    Definition Classes
    ImageFeaturizer → BasicLogging → Identifiable
  171. val ver: String
    Definition Classes
    BasicLogging
  172. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  173. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  174. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  175. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from BasicLogging

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from DotnetWrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from HasOutputCol

Inherited from HasInputCol

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

getParam

param

setParam

Ungrouped