Class

com.salesforce.op.stages.base.sequence

BinarySequenceModel

Related Doc: package sequence

Permalink

abstract class BinarySequenceModel[I1 <: FeatureType, I2 <: FeatureType, O <: FeatureType] extends Model[BinarySequenceModel[I1, I2, O]] with OpTransformer2N[I1, I2, O]

Extend this class and return it from your SequenceEstimator fit function. Takes a sequence of input features of the same type and produces a single new output feature using the specified function. Performs row wise transformation specified in transformFn.

I1

input1 type

I2

input2 type

O

output type

Linear Supertypes
OpTransformer2N[I1, I2, O], OpTransformer, OpPipelineStage2N[I1, I2, O], HasIn1PlusN, HasIn1, OpPipelineStage[O], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Model[BinarySequenceModel[I1, I2, O]], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinarySequenceModel
  2. OpTransformer2N
  3. OpTransformer
  4. OpPipelineStage2N
  5. HasIn1PlusN
  6. HasIn1
  7. OpPipelineStage
  8. OpPipelineStageBase
  9. MLWritable
  10. OpPipelineStageParams
  11. InputParams
  12. Model
  13. Transformer
  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 BinarySequenceModel(operationName: String, uid: String)(implicit tti1: scala.reflect.api.JavaUniverse.TypeTag[I1], tti2: scala.reflect.api.JavaUniverse.TypeTag[I2], tto: scala.reflect.api.JavaUniverse.TypeTag[O], ttov: scala.reflect.api.JavaUniverse.TypeTag[O.Value])

    Permalink

    operationName

    unique name of the operation this stage performs

    uid

    uid for instance

    tti1

    type tag for input1

    tti2

    type tag for input2

    tto

    type tag for output

    ttov

    type tag for output value

Type Members

  1. final type InputFeatures = (FeatureLike[I1], Array[FeatureLike[I2]])

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage2NOpPipelineStageInputParams
  2. type KeyValue = (String) ⇒ Any

    Permalink

    Feature name (key) -> value lookup, e.g Row, Map etc.

    Feature name (key) -> value lookup, e.g Row, Map etc.

    Definition Classes
    OpTransformer
  3. final type OutputFeatures = FeatureLike[O]

    Permalink
    Definition Classes
    OpPipelineStageOpPipelineStageBase

Abstract Value Members

  1. abstract def transformFn: (I1, Seq[I2]) ⇒ O

    Permalink

    Function used to convert input to output

    Function used to convert input to output

    Definition Classes
    OpTransformer2N

Concrete 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
    OpPipelineStage2NInputParams
  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
    OpTransformer2NOpPipelineStageBase
  8. final def clear(param: Param[_]): BinarySequenceModel.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): BinarySequenceModel.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. final def get[T](param: Param[T]): Option[T]

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

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

    Permalink
    Definition Classes
    Params
  23. 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

  24. 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

  25. final def getInputSchema(): StructType

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

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

    Permalink
    Definition Classes
    Params
  28. def getOutput(): FeatureLike[O]

    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
    OpPipelineStage2NOpPipelineStageBase
  29. 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
  30. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  31. 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
  32. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

    Definition Classes
    InputParams
  33. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  35. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  36. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def in1: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  38. final def inN: Array[TransientFeature]

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1PlusN
  39. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. 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
    OpPipelineStage2NInputParams
  42. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  63. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    BinarySequenceModelOpPipelineStageBase
  64. 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
  65. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage2NOpPipelineStage
  66. 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
  67. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  68. var parent: Estimator[BinarySequenceModel[I1, I2, O]]

    Permalink
    Definition Classes
    Model
  69. def save(path: String): Unit

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  75. final def setInput(feature: FeatureLike[I1], features: FeatureLike[I2]*): BinarySequenceModel.this.type

    Permalink
    Definition Classes
    OpPipelineStage2N
  76. final def setInput(features: InputFeatures): BinarySequenceModel.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
  77. final def setInputFeatures[S <: OPFeature](features: Array[S]): BinarySequenceModel.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
  78. final def setMetadata(m: Metadata): BinarySequenceModel.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  79. def setOutputFeatureName(name: String): BinarySequenceModel.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  80. def setParent(parent: Estimator[BinarySequenceModel[I1, I2, O]]): BinarySequenceModel[I1, I2, O]

    Permalink
    Definition Classes
    Model
  81. 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
  82. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  84. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Spark operation on dataset to produce new output feature column using defined function

    Spark operation on dataset to produce new output feature column using defined function

    dataset

    input data for this stage

    returns

    a new dataset containing a column for the transformed feature

    Definition Classes
    OpTransformer2N → Transformer
  85. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  86. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  87. def transformKeyValue: (KeyValue) ⇒ Any

    Permalink

    Creates a transform function to transform any key/value to a value

    Creates a transform function to transform any key/value to a value

    returns

    a transform function to transform any key/value to a value

    Definition Classes
    OpTransformer2N → OpTransformer
  88. def transformMap: (Map[String, Any]) ⇒ Any

    Permalink

    Creates a transform function to transform Map to a value

    Creates a transform function to transform Map to a value

    returns

    a transform function to transform Map to a value

    Definition Classes
    OpTransformer
  89. def transformRow: (Row) ⇒ Any

    Permalink

    Creates a transform function to transform Row to a value

    Creates a transform function to transform Row to a value

    returns

    a transform function to transform Row to a value

    Definition Classes
    OpTransformer
  90. 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
  91. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  92. implicit val tti1: scala.reflect.api.JavaUniverse.TypeTag[I1]

    Permalink

    type tag for input1

    type tag for input1

    Definition Classes
    BinarySequenceModelOpTransformer2N
  93. implicit val tti2: scala.reflect.api.JavaUniverse.TypeTag[I2]

    Permalink

    type tag for input2

    type tag for input2

    Definition Classes
    BinarySequenceModelOpTransformer2N
  94. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[O]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    BinarySequenceModelOpPipelineStage2N
  95. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[O.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    BinarySequenceModelOpPipelineStage2N
  96. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    BinarySequenceModel → Identifiable
  97. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from OpTransformer2N[I1, I2, O]

Inherited from OpTransformer

Inherited from OpPipelineStage2N[I1, I2, O]

Inherited from HasIn1PlusN

Inherited from HasIn1

Inherited from OpPipelineStage[O]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Model[BinarySequenceModel[I1, I2, O]]

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