Trait

com.salesforce.op.stages

InputParams

Related Doc: package stages

Permalink

trait InputParams extends Params

Parameters and functions shared across the input features

Linear Supertypes
Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
BinaryEstimator, BinaryLambdaTransformer, BinaryModel, BinarySequenceEstimator, BinarySequenceLambdaTransformer, BinarySequenceModel, BinarySequenceTransformer, BinaryTransformer, FeatureGeneratorStage, OpPipelineStage, OpPipelineStage1, OpPipelineStage1to2, OpPipelineStage1to3, OpPipelineStage2, OpPipelineStage2N, OpPipelineStage2to2, OpPipelineStage2to3, OpPipelineStage3, OpPipelineStage3to2, OpPipelineStage4, OpPipelineStageBase, OpPipelineStageN, OpPipelineStageParams, OpTransformer1, OpTransformer2, OpTransformer2N, OpTransformer3, OpTransformer4, OpTransformerN, QuaternaryEstimator, QuaternaryLambdaTransformer, QuaternaryModel, QuaternaryTransformer, SequenceEstimator, SequenceLambdaTransformer, SequenceModel, SequenceTransformer, TernaryEstimator, TernaryLambdaTransformer, TernaryModel, TernaryTransformer, UnaryEstimator, UnaryLambdaTransformer, UnaryModel, UnaryTransformer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputParams
  2. Params
  3. Serializable
  4. Serializable
  5. Identifiable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type InputFeatures

    Permalink

    Input Features type

Abstract Value Members

  1. abstract 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

    Attributes
    protected

  2. abstract def copy(extra: ParamMap): Params

    Permalink
    Definition Classes
    Params

  3. implicit abstract 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

    Attributes
    protected

  4. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

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 clear(param: Param[_]): InputParams.this.type

    Permalink
    Definition Classes
    Params

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  9. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  12. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  13. def explainParams(): String

    Permalink
    Definition Classes
    Params

  14. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  15. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

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

    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

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

    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  22. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  23. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

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

  25. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

  26. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  27. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  29. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  31. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  35. def onSetInput(): Unit

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected

  36. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  37. final def set(paramPair: ParamPair[_]): InputParams.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  38. final def set(param: String, value: Any): InputParams.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  39. final def set[T](param: Param[T], value: T): InputParams.this.type

    Permalink
    Definition Classes
    Params

  40. final def setDefault(paramPairs: ParamPair[_]*): InputParams.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  41. final def setDefault[T](param: Param[T], value: T): InputParams.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  42. final def setInputFeatures[S <: OPFeature](features: Array[S]): InputParams.this.type

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected

  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  44. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  45. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped