VectorSHAP implements VectorSHAP More...

Inheritance diagram for Synapse.ML.Explainers.VectorSHAP:

Collaboration diagram for Synapse.ML.Explainers.VectorSHAP:

Public Member Functions
	VectorSHAP ()
	Creates a VectorSHAP without any parameters. More...

	VectorSHAP (string uid)
	Creates a VectorSHAP with a UID that is used to give the VectorSHAP a unique ID. More...

VectorSHAP	SetBackgroundData (DataFrame value)
	Sets value for backgroundData More...

VectorSHAP	SetInfWeight (double value)
	Sets value for infWeight More...

VectorSHAP	SetInputCol (string value)
	Sets value for inputCol More...

VectorSHAP	SetMetricsCol (string value)
	Sets value for metricsCol More...

VectorSHAP	SetModel (JavaTransformer value)
	Sets value for model More...

VectorSHAP	SetNumSamples (int value)
	Sets value for numSamples More...

VectorSHAP	SetOutputCol (string value)
	Sets value for outputCol More...

VectorSHAP	SetTargetClasses (int[] value)
	Sets value for targetClasses More...

VectorSHAP	SetTargetClassesCol (string value)
	Sets value for targetClassesCol More...

VectorSHAP	SetTargetCol (string value)
	Sets value for targetCol More...

DataFrame	GetBackgroundData ()
	Gets backgroundData value More...

double	GetInfWeight ()
	Gets infWeight value More...

string	GetInputCol ()
	Gets inputCol value More...

string	GetMetricsCol ()
	Gets metricsCol value More...

JavaTransformer	GetModel ()
	Gets model value More...

int	GetNumSamples ()
	Gets numSamples value More...

string	GetOutputCol ()
	Gets outputCol value More...

int []	GetTargetClasses ()
	Gets targetClasses value More...

string	GetTargetClassesCol ()
	Gets targetClassesCol value More...

string	GetTargetCol ()
	Gets targetCol value More...

void	Save (string path)
	Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...

JavaMLWriter	Write ()
	Returns a JavaMLWriter instance for this ML instance.

JavaMLReader< VectorSHAP >	Read ()
	Get the corresponding JavaMLReader instance. More...

Static Public Member Functions
static VectorSHAP	Load (string path)
	Loads the VectorSHAP that was previously saved using Save(string). More...

Detailed Description

VectorSHAP implements VectorSHAP

Constructor & Destructor Documentation

◆ VectorSHAP() [1/2]

Synapse.ML.Explainers.VectorSHAP.VectorSHAP ( )

inline

Creates a VectorSHAP without any parameters.

◆ VectorSHAP() [2/2]

Synapse.ML.Explainers.VectorSHAP.VectorSHAP ( string uid )

inline

Creates a VectorSHAP with a UID that is used to give the VectorSHAP a unique ID.

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetBackgroundData()

DataFrame Synapse.ML.Explainers.VectorSHAP.GetBackgroundData ( )

Gets backgroundData value

Returns: backgroundData: A dataframe containing background data

◆ GetInfWeight()

double Synapse.ML.Explainers.VectorSHAP.GetInfWeight ( )

Gets infWeight value

Returns: infWeight: The double value to represent infinite weight. Default: 1E8.

◆ GetInputCol()

string Synapse.ML.Explainers.VectorSHAP.GetInputCol ( )

Gets inputCol value

Returns: inputCol: input column name

◆ GetMetricsCol()

string Synapse.ML.Explainers.VectorSHAP.GetMetricsCol ( )

Gets metricsCol value

Returns: metricsCol: Column name for fitting metrics

◆ GetModel()

JavaTransformer Synapse.ML.Explainers.VectorSHAP.GetModel ( )

inline

Gets model value

Returns: model: The model to be interpreted.

◆ GetNumSamples()

int Synapse.ML.Explainers.VectorSHAP.GetNumSamples ( )

Gets numSamples value

Returns: numSamples: Number of samples to generate.

◆ GetOutputCol()

string Synapse.ML.Explainers.VectorSHAP.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: output column name

◆ GetTargetClasses()

int [] Synapse.ML.Explainers.VectorSHAP.GetTargetClasses ( )

Gets targetClasses value

Returns: targetClasses: The indices of the classes for multinomial classification models. Default: 0.For regression models this parameter is ignored.

◆ GetTargetClassesCol()

string Synapse.ML.Explainers.VectorSHAP.GetTargetClassesCol ( )

Gets targetClassesCol value

Returns: targetClassesCol: The name of the column that specifies the indices of the classes for multinomial classification models.

◆ GetTargetCol()

string Synapse.ML.Explainers.VectorSHAP.GetTargetCol ( )

Gets targetCol value

Returns: targetCol: The column name of the prediction target to explain (i.e. the response variable). This is usually set to "prediction" for regression models and "probability" for probabilistic classification models. Default value: probability

◆ Load()

static VectorSHAP Synapse.ML.Explainers.VectorSHAP.Load ( string path )

static

Loads the VectorSHAP that was previously saved using Save(string).

Parameters

path	The path the previous VectorSHAP was saved to

Returns: New VectorSHAP object, loaded from path.

◆ Read()

JavaMLReader<VectorSHAP> Synapse.ML.Explainers.VectorSHAP.Read ( )

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<VectorSHAP> instance for this ML instance.

◆ Save()

void Synapse.ML.Explainers.VectorSHAP.Save ( string path )

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters

path	The path to save the object to

◆ SetBackgroundData()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetBackgroundData ( DataFrame value )

Sets value for backgroundData

Parameters

value A dataframe containing background data

Returns: New VectorSHAP object

◆ SetInfWeight()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetInfWeight ( double value )

Sets value for infWeight

Parameters

value The double value to represent infinite weight. Default: 1E8.

Returns: New VectorSHAP object

◆ SetInputCol()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetInputCol ( string value )

Sets value for inputCol

Parameters

value input column name

Returns: New VectorSHAP object

◆ SetMetricsCol()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetMetricsCol ( string value )

Sets value for metricsCol

Parameters

value Column name for fitting metrics

Returns: New VectorSHAP object

◆ SetModel()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetModel ( JavaTransformer value )

Sets value for model

Parameters

value The model to be interpreted.

Returns: New VectorSHAP object

◆ SetNumSamples()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetNumSamples ( int value )

Sets value for numSamples

Parameters

value Number of samples to generate.

Returns: New VectorSHAP object

◆ SetOutputCol()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value output column name

Returns: New VectorSHAP object

◆ SetTargetClasses()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetTargetClasses ( int [] value )

Sets value for targetClasses

Parameters

value The indices of the classes for multinomial classification models. Default: 0.For regression models this parameter is ignored.

Returns: New VectorSHAP object

◆ SetTargetClassesCol()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetTargetClassesCol ( string value )

Sets value for targetClassesCol

Parameters

value The name of the column that specifies the indices of the classes for multinomial classification models.

Returns: New VectorSHAP object

◆ SetTargetCol()

VectorSHAP Synapse.ML.Explainers.VectorSHAP.SetTargetCol ( string value )

Sets value for targetCol

Parameters

value The column name of the prediction target to explain (i.e. the response variable). This is usually set to "prediction" for regression models and "probability" for probabilistic classification models. Default value: probability

Returns: New VectorSHAP object

The documentation for this class was generated from the following file:

synapse/ml/explainers/VectorSHAP.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VectorSHAP() [1/2]

◆ VectorSHAP() [2/2]

Member Function Documentation

◆ GetBackgroundData()

◆ GetInfWeight()

◆ GetInputCol()

◆ GetMetricsCol()

◆ GetModel()

◆ GetNumSamples()

◆ GetOutputCol()

◆ GetTargetClasses()

◆ GetTargetClassesCol()

◆ GetTargetCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetBackgroundData()

◆ SetInfWeight()

◆ SetInputCol()

◆ SetMetricsCol()

◆ SetModel()

◆ SetNumSamples()

◆ SetOutputCol()

◆ SetTargetClasses()

◆ SetTargetClassesCol()

◆ SetTargetCol()