TabularLIME implements TabularLIME More...

Inheritance diagram for Synapse.ML.Explainers.TabularLIME:

[legend]

Collaboration diagram for Synapse.ML.Explainers.TabularLIME:

[legend]

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

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

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

TabularLIME	SetCategoricalFeatures (string[] value)
	Sets value for categoricalFeatures More...

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

TabularLIME	SetKernelWidth (double value)
	Sets value for kernelWidth More...

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

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

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

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

TabularLIME	SetRegularization (double value)
	Sets value for regularization More...

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

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

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

DataFrame	GetBackgroundData ()
	Gets backgroundData value More...

string[]	GetCategoricalFeatures ()
	Gets categoricalFeatures value More...

string[]	GetInputCols ()
	Gets inputCols value More...

double	GetKernelWidth ()
	Gets kernelWidth 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...

double	GetRegularization ()
	Gets regularization 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< TabularLIME >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

TabularLIME implements TabularLIME

Constructor & Destructor Documentation

◆ TabularLIME() [1/2]

Synapse.ML.Explainers.TabularLIME.TabularLIME ( )

inline

Creates a TabularLIME without any parameters.

◆ TabularLIME() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetBackgroundData()

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

Gets backgroundData value

Returns: backgroundData: A dataframe containing background data

◆ GetCategoricalFeatures()

string [] Synapse.ML.Explainers.TabularLIME.GetCategoricalFeatures ( )

Gets categoricalFeatures value

Returns: categoricalFeatures: Name of features that should be treated as categorical variables.

◆ GetInputCols()

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

Gets inputCols value

Returns: inputCols: input column names

◆ GetKernelWidth()

double Synapse.ML.Explainers.TabularLIME.GetKernelWidth ( )

Gets kernelWidth value

Returns: kernelWidth: Kernel width. Default value: sqrt (number of features) * 0.75

◆ GetMetricsCol()

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

Gets metricsCol value

Returns: metricsCol: Column name for fitting metrics

◆ GetModel()

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

inline

Gets model value

Returns: model: The model to be interpreted.

◆ GetNumSamples()

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

Gets numSamples value

Returns: numSamples: Number of samples to generate.

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: output column name

◆ GetRegularization()

double Synapse.ML.Explainers.TabularLIME.GetRegularization ( )

Gets regularization value

Returns: regularization: Regularization param for the lasso. Default value: 0.

◆ GetTargetClasses()

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

static

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

Parameters

path	The path the previous TabularLIME was saved to

Returns: New TabularLIME object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for backgroundData

Parameters

value A dataframe containing background data

Returns: New TabularLIME object

◆ SetCategoricalFeatures()

TabularLIME Synapse.ML.Explainers.TabularLIME.SetCategoricalFeatures ( string[] value )

Sets value for categoricalFeatures

Parameters

value Name of features that should be treated as categorical variables.

Returns: New TabularLIME object

◆ SetInputCols()

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

Sets value for inputCols

Parameters

value input column names

Returns: New TabularLIME object

◆ SetKernelWidth()

TabularLIME Synapse.ML.Explainers.TabularLIME.SetKernelWidth ( double value )

Sets value for kernelWidth

Parameters

value Kernel width. Default value: sqrt (number of features) * 0.75

Returns: New TabularLIME object

◆ SetMetricsCol()

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

Sets value for metricsCol

Parameters

value Column name for fitting metrics

Returns: New TabularLIME object

◆ SetModel()

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

Sets value for model

Parameters

value The model to be interpreted.

Returns: New TabularLIME object

◆ SetNumSamples()

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

Sets value for numSamples

Parameters

value Number of samples to generate.

Returns: New TabularLIME object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value output column name

Returns: New TabularLIME object

◆ SetRegularization()

TabularLIME Synapse.ML.Explainers.TabularLIME.SetRegularization ( double value )

Sets value for regularization

Parameters

value Regularization param for the lasso. Default value: 0.

Returns: New TabularLIME object

◆ SetTargetClasses()

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

◆ SetTargetClassesCol()

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

◆ SetTargetCol()

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

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

synapse/ml/explainers/TabularLIME.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TabularLIME() [1/2]

◆ TabularLIME() [2/2]

Member Function Documentation

◆ GetBackgroundData()

◆ GetCategoricalFeatures()

◆ GetInputCols()

◆ GetKernelWidth()

◆ GetMetricsCol()

◆ GetModel()

◆ GetNumSamples()

◆ GetOutputCol()

◆ GetRegularization()

◆ GetTargetClasses()

◆ GetTargetClassesCol()

◆ GetTargetCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetBackgroundData()

◆ SetCategoricalFeatures()

◆ SetInputCols()

◆ SetKernelWidth()

◆ SetMetricsCol()

◆ SetModel()

◆ SetNumSamples()

◆ SetOutputCol()

◆ SetRegularization()

◆ SetTargetClasses()

◆ SetTargetClassesCol()

◆ SetTargetCol()