Inheritance diagram for Synapse.ML.Explainers.TextLIME:

Collaboration diagram for Synapse.ML.Explainers.TextLIME:

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

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

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

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

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

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

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

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

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

TextLIME	SetSamplingFraction (double value)
	Sets value for samplingFraction More...

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

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

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

TextLIME	SetTokensCol (string value)
	Sets value for tokensCol More...

string	GetInputCol ()
	Gets inputCol 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...

double	GetSamplingFraction ()
	Gets samplingFraction value More...

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

string	GetTargetClassesCol ()
	Gets targetClassesCol value More...

string	GetTargetCol ()
	Gets targetCol value More...

string	GetTokensCol ()
	Gets tokensCol 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< TextLIME >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

TextLIME implements TextLIME

Constructor & Destructor Documentation

◆ TextLIME() [1/2]

Synapse.ML.Explainers.TextLIME.TextLIME ( )

inline

Creates a TextLIME without any parameters.

◆ TextLIME() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetInputCol()

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

Gets inputCol value

Returns: inputCol: input column name

◆ GetKernelWidth()

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

Gets kernelWidth value

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

◆ GetMetricsCol()

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

Gets metricsCol value

Returns: metricsCol: Column name for fitting metrics

◆ GetModel()

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

inline

Gets model value

Returns: model: The model to be interpreted.

◆ GetNumSamples()

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

Gets numSamples value

Returns: numSamples: Number of samples to generate.

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: output column name

◆ GetRegularization()

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

Gets regularization value

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

◆ GetSamplingFraction()

double Synapse.ML.Explainers.TextLIME.GetSamplingFraction ( )

Gets samplingFraction value

Returns: samplingFraction: The fraction of superpixels (for image) or tokens (for text) to keep on

◆ GetTargetClasses()

int [] Synapse.ML.Explainers.TextLIME.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.TextLIME.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.TextLIME.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

◆ GetTokensCol()

string Synapse.ML.Explainers.TextLIME.GetTokensCol ( )

Gets tokensCol value

Returns: tokensCol: The column holding the tokens

◆ Load()

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

static

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

Parameters

path	The path the previous TextLIME was saved to

Returns: New TextLIME object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Explainers.TextLIME.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

◆ SetInputCol()

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

Sets value for inputCol

Parameters

value input column name

Returns: New TextLIME object

◆ SetKernelWidth()

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

Sets value for kernelWidth

Parameters

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

Returns: New TextLIME object

◆ SetMetricsCol()

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

Sets value for metricsCol

Parameters

value Column name for fitting metrics

Returns: New TextLIME object

◆ SetModel()

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

Sets value for model

Parameters

value The model to be interpreted.

Returns: New TextLIME object

◆ SetNumSamples()

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

Sets value for numSamples

Parameters

value Number of samples to generate.

Returns: New TextLIME object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value output column name

Returns: New TextLIME object

◆ SetRegularization()

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

Sets value for regularization

Parameters

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

Returns: New TextLIME object

◆ SetSamplingFraction()

TextLIME Synapse.ML.Explainers.TextLIME.SetSamplingFraction ( double value )

Sets value for samplingFraction

Parameters

value The fraction of superpixels (for image) or tokens (for text) to keep on

Returns: New TextLIME object

◆ SetTargetClasses()

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

◆ SetTargetClassesCol()

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

◆ SetTargetCol()

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

◆ SetTokensCol()

TextLIME Synapse.ML.Explainers.TextLIME.SetTokensCol ( string value )

Sets value for tokensCol

Parameters

value The column holding the tokens

Returns: New TextLIME object

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

synapse/ml/explainers/TextLIME.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TextLIME() [1/2]

◆ TextLIME() [2/2]

Member Function Documentation

◆ GetInputCol()

◆ GetKernelWidth()

◆ GetMetricsCol()

◆ GetModel()

◆ GetNumSamples()

◆ GetOutputCol()

◆ GetRegularization()

◆ GetSamplingFraction()

◆ GetTargetClasses()

◆ GetTargetClassesCol()

◆ GetTargetCol()

◆ GetTokensCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetInputCol()

◆ SetKernelWidth()

◆ SetMetricsCol()

◆ SetModel()

◆ SetNumSamples()

◆ SetOutputCol()

◆ SetRegularization()

◆ SetSamplingFraction()

◆ SetTargetClasses()

◆ SetTargetClassesCol()

◆ SetTargetCol()

◆ SetTokensCol()