Class

com.salesforce.op.stages.impl.regression

OpGeneralizedLinearRegressionModel

Related Doc: package regression

Permalink

class OpGeneralizedLinearRegressionModel extends OpPredictorWrapperModel[GeneralizedLinearRegressionModel]

Class that takes in a spark GeneralizedLinearRegressionModel and wraps it into an OP model which returns a Prediction feature

Linear Supertypes
OpPredictorWrapperModel[GeneralizedLinearRegressionModel], OpTransformer2[RealNN, OPVector, Prediction], OpTransformer, OpPipelineStage2[RealNN, OPVector, Prediction], HasOut[Prediction], HasIn2, HasIn1, OpPipelineStage[Prediction], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, SparkWrapperParams[GeneralizedLinearRegressionModel], Model[OpPredictorWrapperModel[GeneralizedLinearRegressionModel]], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpGeneralizedLinearRegressionModel
  2. OpPredictorWrapperModel
  3. OpTransformer2
  4. OpTransformer
  5. OpPipelineStage2
  6. HasOut
  7. HasIn2
  8. HasIn1
  9. OpPipelineStage
  10. OpPipelineStageBase
  11. MLWritable
  12. OpPipelineStageParams
  13. InputParams
  14. SparkWrapperParams
  15. Model
  16. Transformer
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpGeneralizedLinearRegressionModel(sparkModel: GeneralizedLinearRegressionModel, uid: String = ..., operationName: String = ...)(implicit tti1: scala.reflect.api.JavaUniverse.TypeTag[RealNN], tti2: scala.reflect.api.JavaUniverse.TypeTag[OPVector], tto: scala.reflect.api.JavaUniverse.TypeTag[Prediction], ttov: scala.reflect.api.JavaUniverse.TypeTag[Map[String, Double]])

    Permalink

    sparkModel

    model to wrap

    uid

    uid to give stage

    operationName

    unique name of the operation this stage performs

Type Members

  1. final type InputFeatures = (FeatureLike[RealNN], FeatureLike[OPVector])

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage2OpPipelineStageInputParams
  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[Prediction]

    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
    OpPipelineStage2InputParams
  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
    OpTransformer2OpPipelineStageBase
  8. final def clear(param: Param[_]): OpGeneralizedLinearRegressionModel.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): OpGeneralizedLinearRegressionModel.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. implicit val ctag: ClassTag[GeneralizedLinearRegressionModel]

    Permalink
    Definition Classes
    OpPredictorWrapperModel
  13. final def defaultCopy[T <: Params](extra: ParamMap): T

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  24. def getInputColParamNames(): Array[String]

    Permalink

    Gets names of parameters that control input columns for Spark stage

    Gets names of parameters that control input columns for Spark stage

    Definition Classes
    SparkWrapperParams
  25. 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

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

  27. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams
  28. def getLocalMlStage(): Option[Transformer]

    Permalink

    Method to access the local version of stage being wrapped

    Method to access the local version of stage being wrapped

    returns

    Option of ml leap runtime version of the spark stage after reloading as local

    Definition Classes
    SparkWrapperParams
  29. final def getMetadata(): Metadata

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

    Permalink
    Definition Classes
    Params
  31. def getOutput(): FeatureLike[Prediction]

    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
  32. def getOutputColParamNames(): Array[String]

    Permalink

    Gets names of parameters that control output columns for Spark stage

    Gets names of parameters that control output columns for Spark stage

    Definition Classes
    SparkWrapperParams
  33. 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
  34. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  35. def getSparkMlStage(): Option[GeneralizedLinearRegressionModel]

    Permalink

    Method to access the spark stage being wrapped

    Method to access the spark stage being wrapped

    returns

    Option of spark ml stage

    Definition Classes
    SparkWrapperParams
  36. def getSparkOrLocalMethod(sparkMethodName: String, localMethodName: String, argsCount: Option[Int] = None): scala.reflect.api.JavaUniverse.MethodMirror

    Permalink
    Attributes
    protected
    Definition Classes
    OpPredictorWrapperModel
  37. def getStageSavePath(): Option[String]

    Permalink

    Gets a save path for wrapped spark stage

    Gets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  38. 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
  39. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

    Permalink
    Definition Classes
    Params
  42. def hasParent: Boolean

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  45. final def in2: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn2
  46. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    InputParams
  70. val operationName: String

    Permalink

    Short unique name of the operation this stage performs

    Short unique name of the operation this stage performs

    returns

    operation name

    Definition Classes
    OpPredictorWrapperModelOpPipelineStageBase
  71. 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
  72. def outputFeatureUid: String

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

    Permalink
    Definition Classes
    Params
  75. var parent: Estimator[OpPredictorWrapperModel[GeneralizedLinearRegressionModel]]

    Permalink
    Definition Classes
    Model
  76. def predict(features: Vector): Double

    Permalink

    Predict label for the given features

    Predict label for the given features

    Attributes
    protected
    Definition Classes
    OpPredictorWrapperModel
  77. def save(path: String): Unit

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  83. final def setInput(features: InputFeatures): OpGeneralizedLinearRegressionModel.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
  84. final def setInputFeatures[S <: OPFeature](features: Array[S]): OpGeneralizedLinearRegressionModel.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
  85. final def setMetadata(m: Metadata): OpGeneralizedLinearRegressionModel.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  86. def setOutputDF(df: DataFrame): Unit

    Permalink
    Definition Classes
    SparkWrapperParams
  87. def setOutputFeatureName(name: String): OpGeneralizedLinearRegressionModel.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  88. def setParent(parent: Estimator[OpPredictorWrapperModel[GeneralizedLinearRegressionModel]]): OpPredictorWrapperModel[GeneralizedLinearRegressionModel]

    Permalink
    Definition Classes
    Model
  89. def setSparkMlStage(stage: Option[GeneralizedLinearRegressionModel]): OpGeneralizedLinearRegressionModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    SparkWrapperParams
  90. def setStageSavePath(path: String): OpGeneralizedLinearRegressionModel.this.type

    Permalink

    Sets a save path for wrapped spark stage

    Sets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  91. final val sparkInputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  92. final val sparkMlStage: SparkStageParam[GeneralizedLinearRegressionModel]

    Permalink
    Definition Classes
    SparkWrapperParams
  93. val sparkModel: GeneralizedLinearRegressionModel

    Permalink
    Definition Classes
    OpPredictorWrapperModel
  94. final val sparkOutputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  95. 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
  96. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  98. 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
    OpTransformer2 → Transformer
  99. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  101. def transformFn: (RealNN, OPVector) ⇒ Prediction

    Permalink

    Function used to convert input to output

    Function used to convert input to output

    Definition Classes
    OpGeneralizedLinearRegressionModelOpTransformer2
  102. lazy val 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
    OpTransformer2 → OpTransformer
  103. 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
  104. 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
  105. 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
  106. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    OpPredictorWrapperModelOpTransformer2
  108. implicit val tti2: scala.reflect.api.JavaUniverse.TypeTag[OPVector]

    Permalink
    Definition Classes
    OpPredictorWrapperModelOpTransformer2
  109. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[Prediction]

    Permalink

    Type tag of the output

    Type tag of the output

    Definition Classes
    OpPredictorWrapperModel → HasOut
  110. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Map[String, Double]]

    Permalink

    Type tag of the output value

    Type tag of the output value

    Definition Classes
    OpPredictorWrapperModel → HasOut
  111. val uid: String

    Permalink
    Definition Classes
    OpPredictorWrapperModel → Identifiable
  112. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from OpPredictorWrapperModel[GeneralizedLinearRegressionModel]

Inherited from OpTransformer

Inherited from HasOut[Prediction]

Inherited from HasIn2

Inherited from HasIn1

Inherited from OpPipelineStage[Prediction]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from SparkWrapperParams[GeneralizedLinearRegressionModel]

Inherited from Model[OpPredictorWrapperModel[GeneralizedLinearRegressionModel]]

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