Packages

class FeatureBalanceMeasure extends Transformer with DataBalanceParams with HasLabelCol with ComplexParamsWritable with Wrappable with SynapseMLLogging

This transformer computes a set of balance measures from the given dataframe and sensitive features.

The output is a dataframe that contains four columns:

  • The sensitive feature name.
  • A feature value within the sensitive feature.
  • Another feature value within the sensitive feature.
  • A struct containing measure names and their values showing parities between the two feature values. The following measures are computed:
    • Demographic Parity - https://en.wikipedia.org/wiki/Fairness_(machine_learning)
    • Pointwise Mutual Information - https://en.wikipedia.org/wiki/Pointwise_mutual_information
    • Sorensen-Dice Coefficient - https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient
    • Jaccard Index - https://en.wikipedia.org/wiki/Jaccard_index
    • Kendall Rank Correlation - https://en.wikipedia.org/wiki/Kendall_rank_correlation_coefficient
    • Log-Likelihood Ratio - https://en.wikipedia.org/wiki/Likelihood_function#Likelihood_ratio
    • t-test - https://en.wikipedia.org/wiki/Student's_t-test

The output dataframe contains a row per combination of feature values for each sensitive feature.

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

Inherited from SynapseMLLogging

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from HasLabelCol

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