Class/Object

com.microsoft.ml.spark

Featurize

Related Docs: object Featurize | package spark

Permalink

class Featurize extends Estimator[PipelineModel] with MMLParams

Featurizes a dataset. Converts the specified columns to feature columns.

Linear Supertypes
MMLParams, DefaultParamsWritable, MLWritable, Wrappable, Estimator[PipelineModel], PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Featurize
  2. MMLParams
  3. DefaultParamsWritable
  4. MLWritable
  5. Wrappable
  6. Estimator
  7. PipelineStage
  8. Logging
  9. Params
  10. Serializable
  11. Serializable
  12. Identifiable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Featurize()

    Permalink

  2. new Featurize(uid: String)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. def BooleanParam(i: Identifiable, name: String, description: String, default: Boolean): BooleanParam

    Permalink
    Definition Classes
    Wrappable

  6. def BooleanParam(i: Identifiable, name: String, description: String): BooleanParam

    Permalink
    Definition Classes
    Wrappable

  7. def DoubleParam(i: Identifiable, name: String, description: String, default: Double): DoubleParam

    Permalink
    Definition Classes
    Wrappable

  8. def DoubleParam(i: Identifiable, name: String, description: String): DoubleParam

    Permalink
    Definition Classes
    Wrappable

  9. def IntParam(i: Identifiable, name: String, description: String, validation: (Int) ⇒ Boolean): IntParam

    Permalink
    Definition Classes
    Wrappable

  10. def IntParam(i: Identifiable, name: String, description: String, default: Int): IntParam

    Permalink
    Definition Classes
    Wrappable

  11. def IntParam(i: Identifiable, name: String, description: String): IntParam

    Permalink
    Definition Classes
    Wrappable

  12. def LongParam(i: Identifiable, name: String, description: String, default: Long): LongParam

    Permalink
    Definition Classes
    Wrappable

  13. def LongParam(i: Identifiable, name: String, description: String): LongParam

    Permalink
    Definition Classes
    Wrappable

  14. def StringParam(i: Identifiable, name: String, description: String, default: String, domain: Seq[String]): Param[String]

    Permalink
    Definition Classes
    Wrappable

  15. def StringParam(i: Identifiable, name: String, description: String, default: String): Param[String]

    Permalink
    Definition Classes
    Wrappable

  16. def StringParam(i: Identifiable, name: String, description: String, validation: (String) ⇒ Boolean): Param[String]

    Permalink
    Definition Classes
    Wrappable

  17. def StringParam(i: Identifiable, name: String, description: String): Param[String]

    Permalink
    Definition Classes
    Wrappable

  18. val allowImages: Param[Boolean]

    Permalink

    Specifies whether to allow featurization of images

  19. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  20. def chainedUid(origin: String): String

    Permalink
    Definition Classes
    Wrappable

  21. final def clear(param: Param[_]): Featurize.this.type

    Permalink
    Definition Classes
    Params

  22. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. def copy(extra: ParamMap): Estimator[PipelineModel]

    Permalink
    Definition Classes
    Featurize → Estimator → PipelineStage → Params

  24. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  25. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  26. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  28. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  29. def explainParams(): String

    Permalink
    Definition Classes
    Params

  30. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  31. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  32. val featureColumns: MapArrayParam

    Permalink

    Feature columns - the columns to be featurized

  33. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  34. def fit(dataset: Dataset[_]): PipelineModel

    Permalink

    Featurizes the dataset.

    Featurizes the dataset.

    dataset

    The input dataset to train.

    returns

    The featurized model.

    Definition Classes
    Featurize → Estimator

  35. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[PipelineModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  36. def fit(dataset: Dataset[_], paramMap: ParamMap): PipelineModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  37. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): PipelineModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()

  38. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  39. final def getAllowImages: Boolean

    Permalink

  40. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  42. final def getFeatureColumns: Map[String, Seq[String]]

    Permalink

  43. final def getNumberOfFeatures: Int

    Permalink

  44. final def getOneHotEncodeCategoricals: Boolean

    Permalink

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

    Permalink
    Definition Classes
    Params

  46. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  47. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  48. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  49. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  50. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  54. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  55. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  56. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  57. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  58. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  59. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  60. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  61. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  62. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  63. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  64. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  65. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  66. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  67. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  68. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  69. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  70. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  71. val numberOfFeatures: IntParam

    Permalink

    Number of features to hash string columns to

  72. val oneHotEncodeCategoricals: Param[Boolean]

    Permalink

    One hot encode categorical columns when true; default is true

  73. val paramDomains: Map[String, Seq[String]]

    Permalink
    Definition Classes
    Wrappable

  74. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  75. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  76. final def set(paramPair: ParamPair[_]): Featurize.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  77. final def set(param: String, value: Any): Featurize.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  78. final def set[T](param: Param[T], value: T): Featurize.this.type

    Permalink
    Definition Classes
    Params

  79. def setAllowImages(value: Boolean): Featurize.this.type

    Permalink

  80. final def setDefault(paramPairs: ParamPair[_]*): Featurize.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  81. final def setDefault[T](param: Param[T], value: T): Featurize.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  82. def setFeatureColumns(value: Map[String, Seq[String]]): Featurize.this.type

    Permalink

  83. def setNumberOfFeatures(value: Int): Featurize.this.type

    Permalink

  84. def setOneHotEncodeCategoricals(value: Boolean): Featurize.this.type

    Permalink

  85. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  86. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  87. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    Featurize → PipelineStage
    Annotations
    @DeveloperApi()

  88. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  89. val uid: String

    Permalink
    Definition Classes
    Featurize → Identifiable

  90. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  91. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  92. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  93. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from MMLParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Estimator[PipelineModel]

Inherited from PipelineStage

Inherited from org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters

Parameter setters

Parameter getters

Members