Packages

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

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

    Name of the output node which represents features

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

  49. def getChannelNormalizationStds: Array[Double]

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

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

  54. def getFeatureTensorName: String

  55. def getHeadless: Boolean

  56. def getIgnoreDecodingErrors: Boolean

  57. def getImageHeight: Int

  58. def getImageTensorName: String

  59. def getImageWidth: Int

  60. def getInputCol: String

    Definition Classes
    HasInputCol
  61. def getMiniBatchSize: Int

  62. def getModel: Array[Byte]

  63. def getOnnxModel: ONNXModel

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

    Definition Classes
    HasOutputCol
  66. def getOutputTensorName: String

  67. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  68. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  69. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  70. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  71. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  72. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  73. val headless: BooleanParam
  74. val ignoreDecodingErrors: BooleanParam
  75. val imageHeight: IntParam
  76. val imageTensorName: Param[String]

    Name of the input node for images

  77. val imageWidth: IntParam
  78. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  79. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. val inputCol: Param[String]

    The name of the input column

    The name of the input column

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

    The name of the output column

    The name of the output column

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

    Name of the output node which represents probabilities

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

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

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

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

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

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

  155. def setIgnoreDecodingErrors(value: Boolean): ImageFeaturizer.this.type

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

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

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

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

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

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

  162. def setModel(name: String): ImageFeaturizer.this.type
  163. def setModelInfo(info: ONNXModelInfo): ImageFeaturizer.this.type
  164. def setModelLocation(path: String): ImageFeaturizer.this.type
  165. def setOnnxModel(value: ONNXModel): ImageFeaturizer.this.type

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

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

  168. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  169. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  170. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  171. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    ImageFeaturizer → Transformer
  172. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  173. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  174. 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
  175. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  176. val uid: String
    Definition Classes
    ImageFeaturizer → SynapseMLLogging → Identifiable
  177. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  178. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  179. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  180. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from SynapseMLLogging

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