Packages

class AggregateBalanceMeasure extends Transformer with DataBalanceParams with ComplexParamsWritable with Wrappable with BasicLogging

This transformer computes a set of aggregated balance measures that represents how balanced the given dataframe is along the given sensitive features.

The output is a dataframe that contains one column:

  • A struct containing measure names and their values showing higher notions of inequality. The following measures are computed:
    • Atkinson Index - https://en.wikipedia.org/wiki/Atkinson_index
    • Theil Index (L and T) - https://en.wikipedia.org/wiki/Theil_index

The output dataframe contains one row.

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

Instance Constructors

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

    uid

    The unique ID.

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. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  7. final def clear(param: Param[_]): AggregateBalanceMeasure.this.type
    Definition Classes
    Params
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  10. def copy(extra: ParamMap): Transformer
    Definition Classes
    AggregateBalanceMeasure → Transformer → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  12. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  13. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. val epsilon: DoubleParam
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. val errorTolerance: DoubleParam
  18. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  19. def explainParams(): String
    Definition Classes
    Params
  20. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  21. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  26. def getEpsilon: Double
  27. def getErrorTolerance: Double
  28. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  29. final def getOutputCol: String
    Definition Classes
    HasOutputCol
  30. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  31. def getSensitiveCols: Array[String]
    Definition Classes
    DataBalanceParams
  32. def getVerbose: Boolean
    Definition Classes
    DataBalanceParams
  33. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  34. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  37. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  41. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  42. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  43. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  44. def logClass(): Unit
    Definition Classes
    BasicLogging
  45. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  50. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  51. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  54. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  55. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  58. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  59. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  60. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  63. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  67. final val outputCol: Param[String]
    Definition Classes
    HasOutputCol
  68. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  69. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  70. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  71. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  72. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  73. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  74. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  75. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  76. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  77. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  78. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  79. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  80. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  81. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  82. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  83. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  84. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  85. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  86. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  87. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  88. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  89. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  90. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  91. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  92. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  93. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  94. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  95. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  96. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  97. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  98. val sensitiveCols: StringArrayParam
    Definition Classes
    DataBalanceParams
  99. final def set(paramPair: ParamPair[_]): AggregateBalanceMeasure.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def set(param: String, value: Any): AggregateBalanceMeasure.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set[T](param: Param[T], value: T): AggregateBalanceMeasure.this.type
    Definition Classes
    Params
  102. final def setDefault(paramPairs: ParamPair[_]*): AggregateBalanceMeasure.this.type
    Attributes
    protected
    Definition Classes
    Params
  103. final def setDefault[T](param: Param[T], value: T): AggregateBalanceMeasure.this.type
    Attributes
    protected
    Definition Classes
    Params
  104. def setEpsilon(value: Double): AggregateBalanceMeasure.this.type
  105. def setErrorTolerance(value: Double): AggregateBalanceMeasure.this.type
  106. def setOutputCol(value: String): AggregateBalanceMeasure.this.type
    Definition Classes
    DataBalanceParams
  107. def setSensitiveCols(values: Array[String]): AggregateBalanceMeasure.this.type
    Definition Classes
    DataBalanceParams
  108. def setVerbose(value: Boolean): AggregateBalanceMeasure.this.type
    Definition Classes
    DataBalanceParams
  109. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  110. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  111. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AggregateBalanceMeasure → Transformer
  112. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  113. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  114. def transformSchema(schema: StructType): StructType
    Definition Classes
    AggregateBalanceMeasure → PipelineStage
  115. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  116. val uid: String
    Definition Classes
    AggregateBalanceMeasure → BasicLogging → Identifiable
  117. def validateSchema(schema: StructType): Unit
    Definition Classes
    DataBalanceParams
  118. val ver: String
    Definition Classes
    BasicLogging
  119. val verbose: BooleanParam
    Definition Classes
    DataBalanceParams
  120. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  122. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  123. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from BasicLogging

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from DataBalanceParams

Inherited from HasOutputCol

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

Ungrouped