Class/Object

com.microsoft.ml.spark

SummarizeData

Related Docs: object SummarizeData | package spark

Permalink

class SummarizeData extends Transformer with SummarizeDataParams

Compute summary statistics for the dataset. The following statistics are computed: - counts - basic - sample - percentiles - errorThreshold - error threshold for quantiles

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

Instance Constructors

  1. new SummarizeData()

    Permalink

  2. new SummarizeData(uid: String)

    Permalink

    uid

    The id of the module

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  19. final val basic: BooleanParam

    Permalink

    Compute basic statistics.

    Compute basic statistics. Default is true.

    Definition Classes
    SummarizeDataParams

  20. def chainedUid(origin: String): String

    Permalink
    Definition Classes
    Wrappable

  21. final def clear(param: Param[_]): SummarizeData.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): SummarizeData

    Permalink
    Definition Classes
    SummarizeData → Transformer → PipelineStage → Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  25. final val counts: BooleanParam

    Permalink

    Compute count statistics.

    Compute count statistics. Default is true.

    Definition Classes
    SummarizeDataParams

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    AnyRef

  28. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  29. final val errorThreshold: DoubleParam

    Permalink

    Threshold for quantiles - 0 is exact

    Threshold for quantiles - 0 is exact

    Definition Classes
    SummarizeDataParams

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

    Permalink
    Definition Classes
    Params

  31. def explainParams(): String

    Permalink
    Definition Classes
    Params

  32. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  34. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Params

  36. final def getBasic: Boolean

    Permalink

    Definition Classes
    SummarizeDataParams

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

    Permalink
    Definition Classes
    AnyRef → Any

  38. final def getCounts: Boolean

    Permalink

    Definition Classes
    SummarizeDataParams

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

    Permalink
    Definition Classes
    Params

  40. final def getErrorThreshold: Double

    Permalink

    Definition Classes
    SummarizeDataParams

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  43. final def getPercentiles: Boolean

    Permalink

    Definition Classes
    SummarizeDataParams

  44. final def getSample: Boolean

    Permalink

    Definition Classes
    SummarizeDataParams

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

    Permalink
    Definition Classes
    Params

  46. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  47. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    Params

  51. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Params

  53. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  54. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  61. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    AnyRef

  67. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  68. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Wrappable

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

    Permalink
    Definition Classes
    Params

  71. final val percentiles: BooleanParam

    Permalink

    Compute percentiles.

    Compute percentiles. Default is true

    Definition Classes
    SummarizeDataParams

  72. final val sample: BooleanParam

    Permalink

    Compute sample statistics.

    Compute sample statistics. Default is true.

    Definition Classes
    SummarizeDataParams

  73. def save(path: String): Unit

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

  74. final def set(paramPair: ParamPair[_]): SummarizeData.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  75. final def set(param: String, value: Any): SummarizeData.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  77. def setBasic(value: Boolean): SummarizeData.this.type

    Permalink

    Definition Classes
    SummarizeDataParams

  78. def setCounts(value: Boolean): SummarizeData.this.type

    Permalink

    Definition Classes
    SummarizeDataParams

  79. final def setDefault(paramPairs: ParamPair[_]*): SummarizeData.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  81. def setErrorThreshold(value: Double): SummarizeData.this.type

    Permalink

    Definition Classes
    SummarizeDataParams

  82. def setPercentiles(value: Boolean): SummarizeData.this.type

    Permalink

    Definition Classes
    SummarizeDataParams

  83. def setSample(value: Boolean): SummarizeData.this.type

    Permalink

    Definition Classes
    SummarizeDataParams

  84. def setStatistics(stats: List[Statistic]): Unit

    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 transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    SummarizeData → Transformer

  88. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

  89. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

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

  90. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    SummarizeData → PipelineStage

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  92. val uid: String

    Permalink

    The id of the module

    The id of the module

    Definition Classes
    SummarizeData → Identifiable

  93. def validateAndTransformSchema(schema: StructType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    SummarizeDataParams

  94. final def wait(): Unit

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

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

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

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

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

  97. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from SummarizeDataParams

Inherited from MMLParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Transformer

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