Trait

com.salesforce.op.stages

OpPipelineStageBase

Related Doc: package stages

Permalink

trait OpPipelineStageBase extends OpPipelineStageParams with MLWritable

TransmogrifAI Base Pipeline Stage allowing to specify arbitrary Input and Output Feature types

Internally the stage operates and serializes the TransientFeature. However to maintain usability for users, the getters will return FeatureLike objects. It is important that during development these features are not captured into a UDF since the entire DAG will be serialized onto worker nodes. All stage method, when referring to inputs, should access them via HasIn[1,2,3,4,N] traits.

Self Type
OpPipelineStageBase with PipelineStage
Linear Supertypes
MLWritable, OpPipelineStageParams, InputParams, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
AliasTransformer, BinaryEstimator, BinaryLambdaTransformer, BinaryMapVectorizer, BinaryMapVectorizerModel, BinaryModel, BinarySequenceEstimator, BinarySequenceLambdaTransformer, BinarySequenceModel, BinarySequenceTransformer, BinaryTransformer, BinaryVectorizer, DateListVectorizer, DateMapToUnitCircleVectorizer, DateMapToUnitCircleVectorizerModel, DateMapVectorizer, DateMapVectorizerModel, DateToUnitCircleTransformer, DecisionTreeNumericBucketizer, DecisionTreeNumericBucketizerModel, DecisionTreeNumericMapBucketizer, DecisionTreeNumericMapBucketizerModel, DropIndicesByTransformer, FeatureGeneratorStage, FillMissingWithMean, FillMissingWithMeanModel, FilterMap, GeolocationMapVectorizer, GeolocationMapVectorizerModel, GeolocationVectorizer, GeolocationVectorizerModel, IntegralMapVectorizer, IntegralMapVectorizerModel, IntegralVectorizer, IntegralVectorizerModel, IsValidPhoneDefaultCountry, IsValidPhoneMapDefaultCountry, IsValidPhoneNumber, IsotonicRegressionCalibrator, JaccardSimilarity, LangDetector, MapVectorizerFuns, MimeTypeDetector, MimeTypeMapDetector, MultiPickListMapVectorizer, MultiPickListMapVectorizerModel, NameEntityRecognizer, NumericBucketizer, OPCollectionHashingVectorizer, OPCollectionTransformer, OPMapVectorizer, OPMapVectorizerModel, OpBinaryEstimatorWrapper, OpCountVectorizer, OpDecisionTreeClassificationModel, OpDecisionTreeClassifier, OpDecisionTreeRegressionModel, OpDecisionTreeRegressor, OpEstimatorWrapper, OpGBTClassificationModel, OpGBTClassifier, OpGBTRegressionModel, OpGBTRegressor, OpGeneralizedLinearRegression, OpGeneralizedLinearRegressionModel, OpIndexToStringNoFilter, OpLDA, OpLinearRegression, OpLinearRegressionModel, OpLinearSVC, OpLinearSVCModel, OpLogisticRegression, OpLogisticRegressionModel, OpMultilayerPerceptronClassificationModel, OpMultilayerPerceptronClassifier, OpNaiveBayes, OpNaiveBayesModel, OpOneHotVectorizer, OpOneHotVectorizerModel, OpPipelineStage, OpPipelineStage1, OpPipelineStage1to2, OpPipelineStage1to3, OpPipelineStage2, OpPipelineStage2N, OpPipelineStage2to2, OpPipelineStage2to3, OpPipelineStage3, OpPipelineStage3to2, OpPipelineStage4, OpPipelineStageN, OpPredictionModel, OpPredictorWrapper, OpPredictorWrapperModel, OpProbabilisticClassifierModel, OpRandomForestClassificationModel, OpRandomForestClassifier, OpRandomForestRegressionModel, OpRandomForestRegressor, OpScalarStandardScaler, OpScalarStandardScalerModel, OpSetVectorizer, OpSetVectorizerModel, OpStringIndexer, OpStringIndexerNoFilter, OpStringIndexerNoFilterModel, OpTextPivotVectorizer, OpTextPivotVectorizerModel, OpTransformer1, OpTransformer2, OpTransformer2N, OpTransformer3, OpTransformer4, OpTransformerN, OpWord2Vec, OpXGBoostClassificationModel, OpXGBoostClassifier, OpXGBoostRegressionModel, OpXGBoostRegressor, ParsePhoneDefaultCountry, ParsePhoneNumber, PercentileCalibrator, PercentileCalibratorModel, PredictionDeIndexer, PredictionDeIndexerModel, QuaternaryEstimator, QuaternaryLambdaTransformer, QuaternaryModel, QuaternaryTransformer, RealMapVectorizer, RealMapVectorizerModel, RealNNVectorizer, RealVectorizer, RealVectorizerModel, RecordInsightsCorr, RecordInsightsLOCO, SanityChecker, SanityCheckerModel, SelectedModel, SequenceEstimator, SequenceLambdaTransformer, SequenceModel, SequenceTransformer, SmartTextMapVectorizer, SmartTextMapVectorizerModel, SmartTextVectorizer, SmartTextVectorizerModel, SwBinaryEstimator, SwQuaternaryEstimator, SwSequenceEstimator, SwTernaryEstimator, SwUnaryEstimator, TernaryEstimator, TernaryLambdaTransformer, TernaryModel, TernaryTransformer, TextListNullTransformer, TextMapHashingVectorizer, TextMapHashingVectorizerModel, TextMapNullEstimator, TextMapNullModel, TextMapPivotVectorizer, TextMapPivotVectorizerModel, TextTokenizer, ToOccurTransformer, UnaryEstimator, UnaryLambdaTransformer, UnaryModel, UnaryTransformer, VectorizerDefaults, VectorsCombiner, VectorsCombinerModel
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpPipelineStageBase
  2. MLWritable
  3. OpPipelineStageParams
  4. InputParams
  5. Params
  6. Serializable
  7. Serializable
  8. Identifiable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type InputFeatures

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    InputParams
  2. abstract type OutputFeatures

    Permalink

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
    Definition Classes
    InputParams
  2. abstract def getOutput(): (OpPipelineStageBase.this)#OutputFeatures

    Permalink

    Output features that will be created by this stage

    Output features that will be created by this stage

    returns

    feature of type OutputFeatures

  3. implicit abstract def inputAsArray(in: (OpPipelineStageBase.this)#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
    Definition Classes
    InputParams
  4. abstract def operationName: String

    Permalink

    Short unique name of the operation this stage performs

    Short unique name of the operation this stage performs

    returns

    operation name

  5. implicit abstract def outputAsArray(out: (OpPipelineStageBase.this)#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

    Attributes
    protected
  6. 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. def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

  7. final def clear(param: Param[_]): OpPipelineStageBase.this

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

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

    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
  10. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def get[T](param: Param[T]): Option[T]

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

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

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

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

  24. final def getInputSchema(): StructType

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

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

    Permalink
    Definition Classes
    Params
  27. def getParam(paramName: String): Param[Any]

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

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  33. final def isDefined(param: Param[_]): Boolean

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

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

    Permalink
    Definition Classes
    Params
  36. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
  41. lazy val params: Array[Param[_]]

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  44. final def set(param: String, value: Any): OpPipelineStageBase.this

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

    Permalink
    Definition Classes
    Params
  46. final def setDefault(paramPairs: ParamPair[_]*): OpPipelineStageBase.this

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  48. final def setInput(features: (OpPipelineStageBase.this)#InputFeatures): OpPipelineStageBase.this

    Permalink

    Input features that will be used by the stage

    Input features that will be used by the stage

    returns

    feature of type InputFeatures

  49. final def setInputFeatures[S <: OPFeature](features: Array[S]): OpPipelineStageBase.this

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected
    Definition Classes
    InputParams
  50. final def setMetadata(m: Metadata): OpPipelineStageBase.this

    Permalink
    Definition Classes
    OpPipelineStageParams
  51. 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

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  54. 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

  55. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped