TabularSHAP implements TabularSHAP More...

Inheritance diagram for Synapse.ML.Explainers.TabularSHAP:

Collaboration diagram for Synapse.ML.Explainers.TabularSHAP:

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

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

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

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

TabularSHAP	SetInputCols (string[] value)
	Sets value for inputCols More...

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

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

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

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

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

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

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

DataFrame	GetBackgroundData ()
	Gets backgroundData value More...

double	GetInfWeight ()
	Gets infWeight value More...

string []	GetInputCols ()
	Gets inputCols 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< TabularSHAP >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

TabularSHAP implements TabularSHAP

Constructor & Destructor Documentation

◆ TabularSHAP() [1/2]

Synapse.ML.Explainers.TabularSHAP.TabularSHAP ( )

inline

Creates a TabularSHAP without any parameters.

◆ TabularSHAP() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetBackgroundData()

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

Gets backgroundData value

Returns: backgroundData: A dataframe containing background data

◆ GetInfWeight()

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

Gets infWeight value

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

◆ GetInputCols()

string [] Synapse.ML.Explainers.TabularSHAP.GetInputCols ( )

Gets inputCols value

Returns: inputCols: input column names

◆ GetMetricsCol()

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

Gets metricsCol value

Returns: metricsCol: Column name for fitting metrics

◆ GetModel()

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

inline

Gets model value

Returns: model: The model to be interpreted.

◆ GetNumSamples()

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

Gets numSamples value

Returns: numSamples: Number of samples to generate.

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: output column name

◆ GetTargetClasses()

int [] Synapse.ML.Explainers.TabularSHAP.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.TabularSHAP.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.TabularSHAP.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 TabularSHAP Synapse.ML.Explainers.TabularSHAP.Load ( string path )

static

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

Parameters

path	The path the previous TabularSHAP was saved to

Returns: New TabularSHAP object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Explainers.TabularSHAP.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()

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

Sets value for backgroundData

Parameters

value A dataframe containing background data

Returns: New TabularSHAP object

◆ SetInfWeight()

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

Sets value for infWeight

Parameters

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

Returns: New TabularSHAP object

◆ SetInputCols()

TabularSHAP Synapse.ML.Explainers.TabularSHAP.SetInputCols ( string [] value )

Sets value for inputCols

Parameters

value input column names

Returns: New TabularSHAP object

◆ SetMetricsCol()

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

Sets value for metricsCol

Parameters

value Column name for fitting metrics

Returns: New TabularSHAP object

◆ SetModel()

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

Sets value for model

Parameters

value The model to be interpreted.

Returns: New TabularSHAP object

◆ SetNumSamples()

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

Sets value for numSamples

Parameters

value Number of samples to generate.

Returns: New TabularSHAP object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value output column name

Returns: New TabularSHAP object

◆ SetTargetClasses()

TabularSHAP Synapse.ML.Explainers.TabularSHAP.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 TabularSHAP object

◆ SetTargetClassesCol()

TabularSHAP Synapse.ML.Explainers.TabularSHAP.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 TabularSHAP object

◆ SetTargetCol()

TabularSHAP Synapse.ML.Explainers.TabularSHAP.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 TabularSHAP object

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

synapse/ml/explainers/TabularSHAP.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TabularSHAP() [1/2]

◆ TabularSHAP() [2/2]

Member Function Documentation

◆ GetBackgroundData()

◆ GetInfWeight()

◆ GetInputCols()

◆ GetMetricsCol()

◆ GetModel()

◆ GetNumSamples()

◆ GetOutputCol()

◆ GetTargetClasses()

◆ GetTargetClassesCol()

◆ GetTargetCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetBackgroundData()

◆ SetInfWeight()

◆ SetInputCols()

◆ SetMetricsCol()

◆ SetModel()

◆ SetNumSamples()

◆ SetOutputCol()

◆ SetTargetClasses()

◆ SetTargetClassesCol()

◆ SetTargetCol()