Class

com.salesforce.op.stages.impl.insights

RecordInsightsCorr

Related Doc: package insights

Permalink

class RecordInsightsCorr extends BinaryEstimator[OPVector, OPVector, TextMap]

Creates record level insights for model predictions. Takes two inputs the first is the predictions to explain and the second feature vector fed into the model. Note that regression outputs must be converted into a vector with one column in order to use this estimator

Linear Supertypes
BinaryEstimator[OPVector, OPVector, TextMap], OpPipelineStage2[OPVector, OPVector, TextMap], HasOut[TextMap], HasIn2, HasIn1, OpPipelineStage[TextMap], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[BinaryModel[OPVector, OPVector, TextMap]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordInsightsCorr
  2. BinaryEstimator
  3. OpPipelineStage2
  4. HasOut
  5. HasIn2
  6. HasIn1
  7. OpPipelineStage
  8. OpPipelineStageBase
  9. MLWritable
  10. OpPipelineStageParams
  11. InputParams
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RecordInsightsCorr(uid: String = UID[RecordInsightsCorr])

    Permalink

    uid

    uid for instance

Type Members

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

    Permalink
    Definition Classes
    OpPipelineStage2 → OpPipelineStage → InputParams
  2. final type OutputFeatures = FeatureLike[TextMap]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase

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
    Definition Classes
    OpPipelineStage2 → InputParams
  7. final def checkSerializable: Try[Unit]

    Permalink
    Definition Classes
    BinaryEstimator → OpPipelineStageBase
  8. final def clear(param: Param[_]): RecordInsightsCorr.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val convertI1: FeatureTypeSparkConverter[OPVector]

    Permalink
    Definition Classes
    BinaryEstimator
  11. val convertI2: FeatureTypeSparkConverter[OPVector]

    Permalink
    Definition Classes
    BinaryEstimator
  12. final def copy(extra: ParamMap): RecordInsightsCorr.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. final val correlationType: Param[CorrelationType]

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def fit(dataset: Dataset[_]): BinaryModel[OPVector, OPVector, TextMap]

    Permalink
    Definition Classes
    BinaryEstimator → Estimator
  24. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[BinaryModel[OPVector, OPVector, TextMap]]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  25. def fit(dataset: Dataset[_], paramMap: ParamMap): BinaryModel[OPVector, OPVector, TextMap]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): BinaryModel[OPVector, OPVector, TextMap]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  27. def fitFn(dataset: Dataset[(Vector, Vector)]): RecordInsightsCorrModel

    Permalink
    Definition Classes
    RecordInsightsCorr → BinaryEstimator
  28. final def get[T](param: Param[T]): Option[T]

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

    Permalink
    Definition Classes
    AnyRef → Any
  30. def getCorrelationType: CorrelationType

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

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

    Permalink
    Definition Classes
    InputParams
  33. final def getInputFeatures(): Array[OPFeature]

    Permalink
    Definition Classes
    InputParams
  34. final def getInputSchema(): StructType

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

    Permalink
    Definition Classes
    OpPipelineStageParams
  36. def getNormType: NormType

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

    Permalink
    Definition Classes
    Params
  38. def getOutput(): FeatureLike[TextMap]

    Permalink
    Definition Classes
    HasOut
  39. final def getOutputFeatureName: String

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

    Permalink
    Definition Classes
    Params
  41. def getTopK: Int

    Permalink
  42. final def getTransientFeature(i: Int): Option[TransientFeature]

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  47. implicit val i1Encoder: Encoder[Value]

    Permalink
    Definition Classes
    BinaryEstimator
  48. implicit val i2Encoder: Encoder[Value]

    Permalink
    Definition Classes
    BinaryEstimator
  49. final def in1: TransientFeature

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

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

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

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

    Permalink
    Definition Classes
    OpPipelineStage2 → InputParams
  54. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  71. final val normType: Param[NormType]

    Permalink
  72. final def notify(): Unit

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

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

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

    Permalink

    Note it is not strictly necessary for in1 to be a response but this is the only way of verifying the order of the inputs

    Note it is not strictly necessary for in1 to be a response but this is the only way of verifying the order of the inputs

    Attributes
    protected
    Definition Classes
    RecordInsightsCorr → InputParams
  76. val operationName: String

    Permalink
    Definition Classes
    BinaryEstimator → OpPipelineStageBase
  77. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase
  78. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage2 → OpPipelineStage
  79. def outputIsResponse: Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  85. def setCorrelationType(value: CorrelationType): RecordInsightsCorr.this.type

    Permalink
  86. final def setDefault(paramPairs: ParamPair[_]*): RecordInsightsCorr.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  88. final def setInput(features: InputFeatures): RecordInsightsCorr.this.type

    Permalink
    Definition Classes
    OpPipelineStageBase
  89. final def setInputFeatures[S <: OPFeature](features: Array[S]): RecordInsightsCorr.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    InputParams
  90. final def setMetadata(m: Metadata): RecordInsightsCorr.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  91. def setNormType(value: NormType): RecordInsightsCorr.this.type

    Permalink
  92. def setOutputFeatureName(name: String): RecordInsightsCorr.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  93. def setTopK(value: Int): RecordInsightsCorr.this.type

    Permalink
  94. final def stageName: String

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  97. final val topK: IntParam

    Permalink
  98. final def transformSchema(schema: StructType): StructType

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

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

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

    Permalink
    Definition Classes
    BinaryEstimator
  102. implicit val ttiv1: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink
    Definition Classes
    BinaryEstimator
  103. implicit val ttiv2: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink
    Definition Classes
    BinaryEstimator
  104. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[TextMap]

    Permalink
    Definition Classes
    BinaryEstimator → HasOut
  105. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[features.types.TextMap.Value]

    Permalink
    Definition Classes
    BinaryEstimator → HasOut
  106. implicit val tupleEncoder: Encoder[(Value, Value)]

    Permalink
    Definition Classes
    BinaryEstimator
  107. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    BinaryEstimator → Identifiable
  108. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from BinaryEstimator[OPVector, OPVector, TextMap]

Inherited from OpPipelineStage2[OPVector, OPVector, TextMap]

Inherited from HasOut[TextMap]

Inherited from HasIn2

Inherited from HasIn1

Inherited from OpPipelineStage[TextMap]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[BinaryModel[OPVector, OPVector, TextMap]]

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