com.salesforce.op.stages.impl.insights
RecordInsightsLOCO
Related Doc: package insights
model instance that you wish to explain
uid for instance
Input Features type
Input Features type
Feature name (key) -> value lookup, e.g Row, Map etc.
Feature name (key) -> value lookup, e.g Row, Map etc.
Checks the input length
Checks the input length
input features
true is input size as expected, false otherwise
Check if the stage is serializable
Check if the stage is serializable
Failure if not serializable
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).
new parameters want to add to instance
a new instance with the same uid
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
array of features
NoSuchElementException if the features are not set
RuntimeException in case one of the features is null
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
array of features
NoSuchElementException if the features are not set
RuntimeException in case one of the features is null
Output features that will be created by this stage
Output features that will be created by this stage
feature of type OutputFeatures
Name of output feature (i.e.
Name of output feature (i.e. column created by this stage)
Gets an input feature at index i
Gets an input feature at index i
input index
maybe an input feature
Gets the input Features
Function to convert InputFeatures to an Array of FeatureLike
Function to convert InputFeatures to an Array of FeatureLike
an Array of FeatureLike
model instance that you wish to explain
Function to be called on getMetadata
Function to be called on getMetadata
Function to be called on setInput
Function to be called on setInput
unique name of the operation this stage performs
unique name of the operation this stage performs
Function to convert OutputFeatures to an Array of FeatureLike
Function to convert OutputFeatures to an Array of FeatureLike
an Array of FeatureLike
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.
true if the the output feature should be a response
Input features that will be used by the stage
Input features that will be used by the stage
feature of type InputFeatures
Sets input features
Sets input features
feature like type
array of input features
this stage
Stage unique name consisting of the stage operation name and uid
Stage unique name consisting of the stage operation name and uid
stage name
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
input data for this stage
a new dataset containing a column for the transformed feature
Function used to convert input to output
Function used to convert input to output
Creates a transform function to transform any key/value to a value
Creates a transform function to transform any key/value to a value
a transform function to transform any key/value to a value
Creates a transform function to transform Map to a value
Creates a transform function to transform Map to a value
a transform function to transform Map to a value
Creates a transform function to transform Row to a value
Creates a transform function to transform Row to a value
a transform function to transform Row to a value
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 of the input data frame
a new schema with the output features added
type tag for input
type tag for input
type tag for output
type tag for output
type tag for output value
type tag for output value
uid for instance
uid for instance
Creates record level insights for model predictions. Takes the model to explain as a constructor argument. The input feature is the feature vector fed into the model.
The map's contents are different regarding the value of the topKStrategy param (only for Binary Classification and Regression) : - If PositiveNegative, returns at most 2 * topK elements : the topK most positive and the topK most negative derived features based on the LOCO insight.For MultiClassification, the value is from the predicted class (i.e. the class having the highest probability) - If Abs, returns at most topK elements : the topK derived features having highest absolute value of LOCO score.