Class

com.salesforce.op.stages.impl.feature

HumanNameDetector

Related Doc: package feature

Permalink

class HumanNameDetector[T <: Text] extends UnaryEstimator[T, NameStats] with NameDetectFun[T]

Unary estimator for identifying whether a single Text column is a name or not. If the column does appear to be a name, a custom map will be returned that contains the guessed gender for each entry (gender detection only supported for English at the moment). If the column does not appear to be a name, then the output will be an empty map.

T

the FeatureType (subtype of Text) to operate over

Linear Supertypes
NameDetectFun[T], NameDetectParams, UnaryEstimator[T, NameStats], OpPipelineStage1[T, NameStats], HasOut[NameStats], HasIn1, OpPipelineStage[NameStats], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[UnaryModel[T, NameStats]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HumanNameDetector
  2. NameDetectFun
  3. NameDetectParams
  4. UnaryEstimator
  5. OpPipelineStage1
  6. HasOut
  7. HasIn1
  8. OpPipelineStage
  9. OpPipelineStageBase
  10. MLWritable
  11. OpPipelineStageParams
  12. InputParams
  13. Estimator
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HumanNameDetector(uid: String = UID[HumanNameDetector[T]], operationName: String = "humanNameDetect")(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T], ttiv: scala.reflect.api.JavaUniverse.TypeTag[Option[String]])

    Permalink

    uid

    uid for instance

    operationName

    unique name of the operation this stage performs

    tti

    type tag for input

    ttiv

    type tag for input value

Type Members

  1. final type InputFeatures = FeatureLike[T]

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage1OpPipelineStageInputParams
  2. final type OutputFeatures = FeatureLike[NameStats]

    Permalink
    Definition Classes
    OpPipelineStageOpPipelineStageBase

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

    Permalink
    Definition Classes
    Any
  6. final def checkInputLength(features: Array[_]): Boolean

    Permalink

    Checks the input length

    Checks the input length

    features

    input features

    returns

    true is input size as expected, false otherwise

    Definition Classes
    OpPipelineStage1InputParams
  7. final def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

    Definition Classes
    UnaryEstimatorOpPipelineStageBase
  8. final def clear(param: Param[_]): HumanNameDetector.this.type

    Permalink
    Definition Classes
    Params
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def copy(extra: ParamMap): HumanNameDetector.this.type

    Permalink

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    Note: that the convention in spark is to have the uid be a constructor argument, so that copies will share a uid with the original (developers should follow this convention).

    extra

    new parameters want to add to instance

    returns

    a new instance with the same uid

    Definition Classes
    OpPipelineStageBase → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  16. def explainParams(): String

    Permalink
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def fit(dataset: Dataset[_]): UnaryModel[T, NameStats]

    Permalink

    Spark operation on dataset to produce Dataset for constructor fit function and then turn output function into a Model

    Spark operation on dataset to produce Dataset for constructor fit function and then turn output function into a Model

    dataset

    input data for this stage

    returns

    a fitted model that will perform the transformation specified by the function defined in constructor fit

    Definition Classes
    UnaryEstimator → Estimator
  21. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[UnaryModel[T, NameStats]]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  22. def fit(dataset: Dataset[_], paramMap: ParamMap): UnaryModel[T, NameStats]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): UnaryModel[T, NameStats]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  24. def fitFn(dataset: Dataset[Option[String]]): HumanNameDetectorModel[T]

    Permalink

    Function that fits the unary model

    Function that fits the unary model

    Definition Classes
    HumanNameDetectorUnaryEstimator
  25. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  28. final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

    Permalink

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  29. final def getInputFeatures(): Array[OPFeature]

    Permalink

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  30. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams
  31. final def getMetadata(): Metadata

    Permalink
    Definition Classes
    OpPipelineStageParams
  32. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  33. def getOutput(): FeatureLike[NameStats]

    Permalink

    Output features that will be created by this stage

    Output features that will be created by this stage

    returns

    feature of type OutputFeatures

    Definition Classes
    HasOut → OpPipelineStageBase
  34. final def getOutputFeatureName: String

    Permalink

    Name of output feature (i.e.

    Name of output feature (i.e. column created by this stage)

    Definition Classes
    OpPipelineStage
  35. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  36. final def getTransientFeature(i: Int): Option[TransientFeature]

    Permalink

    Gets an input feature at index i

    Gets an input feature at index i

    i

    input index

    returns

    maybe an input feature

    Definition Classes
    InputParams
  37. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

    Definition Classes
    InputParams
  38. val guardMaxNumberOfTokens: IntParam

    Permalink
    Definition Classes
    NameDetectParams
  39. val guardMinCountForStdDevCheck: IntParam

    Permalink
    Definition Classes
    NameDetectParams
  40. val guardMinCountForUniqueCheck: IntParam

    Permalink
    Definition Classes
    NameDetectParams
  41. val guardMinStdDev: DoubleParam

    Permalink
    Definition Classes
    NameDetectParams
  42. val guardMinTextLength: IntParam

    Permalink
    Definition Classes
    NameDetectParams
  43. val guardMinUniqueCheck: IntParam

    Permalink
    Definition Classes
    NameDetectParams
  44. val guardPctMaxNumberOfTokens: DoubleParam

    Permalink
    Definition Classes
    NameDetectParams
  45. val guardPctMinTextLength: DoubleParam

    Permalink
    Definition Classes
    NameDetectParams
  46. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  47. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  48. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  49. val iConvert: FeatureTypeSparkConverter[T]

    Permalink
    Definition Classes
    UnaryEstimator
  50. implicit val iEncoder: Encoder[T.Value]

    Permalink
    Definition Classes
    UnaryEstimator
  51. val ignoreNulls: BooleanParam

    Permalink
    Definition Classes
    NameDetectParams
  52. final def in1: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  53. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. final def inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink

    Function to convert InputFeatures to an Array of FeatureLike

    Function to convert InputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStage1InputParams
  56. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  57. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  58. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  59. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. val nameThreshold: DoubleParam

    Permalink
    Definition Classes
    NameDetectParams
  73. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  74. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  75. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  76. def onGetMetadata(): Unit

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

    Attributes
    protected
    Definition Classes
    OpPipelineStageParams
  77. def onSetInput(): Unit

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    InputParams
  78. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    UnaryEstimatorOpPipelineStageBase
  79. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink

    Function to convert OutputFeatures to an Array of FeatureLike

    Function to convert OutputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStageOpPipelineStageBase
  80. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage1OpPipelineStage
  81. def outputIsResponse: Boolean

    Permalink

    Should output feature be a response? Yes, if any of the input features are.

    Should output feature be a response? Yes, if any of the input features are.

    returns

    true if the the output feature should be a response

    Definition Classes
    OpPipelineStage
  82. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  83. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  84. final def set(paramPair: ParamPair[_]): HumanNameDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  85. final def set(param: String, value: Any): HumanNameDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  86. final def set[T](param: Param[T], value: T): HumanNameDetector.this.type

    Permalink
    Definition Classes
    Params
  87. final def setDefault(paramPairs: ParamPair[_]*): HumanNameDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  88. final def setDefault[T](param: Param[T], value: T): HumanNameDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  89. def setGuardCheckValues(maxNumberOfTokens: Int = $(guardMaxNumberOfTokens), pctMaxNumberOfTokens: Double = $(guardPctMaxNumberOfTokens), minTextLength: Int = $(guardMinTextLength), pctMinTextLength: Double = $(guardPctMinTextLength), minCountForStdDevCheck: Int = $(guardMinCountForStdDevCheck), minStdDev: Double = $(guardMinStdDev), minCountForUniqueCheck: Int = $(guardMinCountForUniqueCheck), minUniqueCheck: Int = $(guardMinUniqueCheck)): HumanNameDetector.this.type

    Permalink
    Definition Classes
    NameDetectParams
  90. def setIgnoreNulls(value: Boolean): HumanNameDetector.this.type

    Permalink
    Definition Classes
    NameDetectParams
  91. final def setInput(features: InputFeatures): HumanNameDetector.this.type

    Permalink

    Input features that will be used by the stage

    Input features that will be used by the stage

    returns

    feature of type InputFeatures

    Definition Classes
    OpPipelineStageBase
  92. final def setInputFeatures[S <: OPFeature](features: Array[S]): HumanNameDetector.this.type

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected
    Definition Classes
    InputParams
  93. final def setMetadata(m: Metadata): HumanNameDetector.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  94. def setOutputFeatureName(name: String): HumanNameDetector.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  95. def setThreshold(value: Double): HumanNameDetector.this.type

    Permalink
    Definition Classes
    NameDetectParams
  96. final def stageName: String

    Permalink

    Stage unique name consisting of the stage operation name and uid

    Stage unique name consisting of the stage operation name and uid

    returns

    stage name

    Definition Classes
    OpPipelineStageBase
  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  98. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  99. final def transformSchema(schema: StructType): StructType

    Permalink

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    schema

    schema of the input data frame

    returns

    a new schema with the output features added

    Definition Classes
    OpPipelineStageBase
  100. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  101. implicit val tti: scala.reflect.api.JavaUniverse.TypeTag[T]

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    UnaryEstimator
  102. implicit val ttiv: scala.reflect.api.JavaUniverse.TypeTag[Option[String]]

    Permalink

    type tag for input value

    type tag for input value

    Definition Classes
    HumanNameDetectorUnaryEstimator
  103. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[NameStats]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    UnaryEstimator → HasOut
  104. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[features.types.NameStats.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    UnaryEstimator → HasOut
  105. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    UnaryEstimator → Identifiable
  106. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from NameDetectFun[T]

Inherited from NameDetectParams

Inherited from UnaryEstimator[T, NameStats]

Inherited from OpPipelineStage1[T, NameStats]

Inherited from HasOut[NameStats]

Inherited from HasIn1

Inherited from OpPipelineStage[NameStats]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[UnaryModel[T, NameStats]]

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