Packages

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

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
SynapseMLLogging, 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. SynapseMLLogging
  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 clear(param: Param[_]): AggregateBalanceMeasure.this.type
    Definition Classes
    Params
  2. def copy(extra: ParamMap): Transformer
    Definition Classes
    AggregateBalanceMeasure → Transformer → PipelineStage → Params
  3. val epsilon: DoubleParam
  4. val errorTolerance: DoubleParam
  5. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  6. def explainParams(): String
    Definition Classes
    Params
  7. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  8. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  9. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  10. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  11. def getEpsilon: Double
  12. def getErrorTolerance: Double
  13. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  14. final def getOutputCol: String
    Definition Classes
    HasOutputCol
  15. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  16. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  17. def getSensitiveCols: Array[String]
    Definition Classes
    DataBalanceParams
  18. def getVerbose: Boolean
    Definition Classes
    DataBalanceParams
  19. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  20. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  21. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  22. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  23. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  24. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  25. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  26. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  27. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  28. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  29. final val outputCol: Param[String]
    Definition Classes
    HasOutputCol
  30. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  31. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  32. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  33. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  34. val sensitiveCols: StringArrayParam
    Definition Classes
    DataBalanceParams
  35. final def set[T](param: Param[T], value: T): AggregateBalanceMeasure.this.type
    Definition Classes
    Params
  36. def setEpsilon(value: Double): AggregateBalanceMeasure.this.type
  37. def setErrorTolerance(value: Double): AggregateBalanceMeasure.this.type
  38. def setOutputCol(value: String): AggregateBalanceMeasure.this.type
    Definition Classes
    DataBalanceParams
  39. def setSensitiveCols(values: Array[String]): AggregateBalanceMeasure.this.type
    Definition Classes
    DataBalanceParams
  40. def setVerbose(value: Boolean): AggregateBalanceMeasure.this.type
    Definition Classes
    DataBalanceParams
  41. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  42. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AggregateBalanceMeasure → Transformer
  43. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  44. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  45. def transformSchema(schema: StructType): StructType
    Definition Classes
    AggregateBalanceMeasure → PipelineStage
  46. val uid: String
    Definition Classes
    AggregateBalanceMeasure → SynapseMLLogging → Identifiable
  47. def validateSchema(schema: StructType): Unit
    Definition Classes
    DataBalanceParams
  48. val verbose: BooleanParam
    Definition Classes
    DataBalanceParams
  49. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable