Synapse.ML.Lime.TextLIME Class Reference

TextLIME implements TextLIME More...

Inheritance diagram for Synapse.ML.Lime.TextLIME:

Collaboration diagram for Synapse.ML.Lime.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	SetModel (JavaTransformer value)
	Sets value for model More...
TextLIME	SetNSamples (int value)
	Sets value for nSamples More...
TextLIME	SetOutputCol (string value)
	Sets value for outputCol More...
TextLIME	SetPredictionCol (string value)
	Sets value for predictionCol More...
TextLIME	SetRegularization (double value)
	Sets value for regularization More...
TextLIME	SetSamplingFraction (double value)
	Sets value for samplingFraction More...
TextLIME	SetTokenCol (string value)
	Sets value for tokenCol More...
string	GetInputCol ()
	Gets inputCol value More...
JavaTransformer	GetModel ()
	Gets model value More...
int	GetNSamples ()
	Gets nSamples value More...
string	GetOutputCol ()
	Gets outputCol value More...
string	GetPredictionCol ()
	Gets predictionCol value More...
double	GetRegularization ()
	Gets regularization value More...
double	GetSamplingFraction ()
	Gets samplingFraction value More...
string	GetTokenCol ()
	Gets tokenCol 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.Lime.TextLIME.TextLIME ( )

inline

Creates a TextLIME without any parameters.

TextLIME() [2/2]

Synapse.ML.Lime.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.Lime.TextLIME.GetInputCol

(

)

Gets inputCol value

Returns

inputCol: The name of the input column

GetModel()

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

inline

Gets model value

Returns

model: Model to try to locally approximate

GetNSamples()

int Synapse.ML.Lime.TextLIME.GetNSamples

(

)

Gets nSamples value

Returns

nSamples: The number of samples to generate

GetOutputCol()

string Synapse.ML.Lime.TextLIME.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPredictionCol()

string Synapse.ML.Lime.TextLIME.GetPredictionCol

(

)

Gets predictionCol value

Returns

predictionCol: prediction column name

GetRegularization()

double Synapse.ML.Lime.TextLIME.GetRegularization

(

)

Gets regularization value

Returns

regularization: regularization param for the lasso

GetSamplingFraction()

double Synapse.ML.Lime.TextLIME.GetSamplingFraction

(

)

Gets samplingFraction value

Returns

samplingFraction: The fraction of superpixels to keep on

GetTokenCol()

string Synapse.ML.Lime.TextLIME.GetTokenCol

(

)

Gets tokenCol value

Returns

tokenCol: The column holding the token

Load()

static TextLIME Synapse.ML.Lime.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.Lime.TextLIME.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<TextLIME> instance for this ML instance.

Save()

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

(

string

value

)

Sets value for inputCol

Parameters

value

The name of the input column

Returns

New TextLIME object

SetModel()

TextLIME Synapse.ML.Lime.TextLIME.SetModel

(

JavaTransformer

value

)

Sets value for model

Parameters

value

Model to try to locally approximate

Returns

New TextLIME object

SetNSamples()

TextLIME Synapse.ML.Lime.TextLIME.SetNSamples

(

int

value

)

Sets value for nSamples

Parameters

value

The number of samples to generate

Returns

New TextLIME object

SetOutputCol()

TextLIME Synapse.ML.Lime.TextLIME.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New TextLIME object

SetPredictionCol()

TextLIME Synapse.ML.Lime.TextLIME.SetPredictionCol

(

string

value

)

Sets value for predictionCol

Parameters

value

prediction column name

Returns

New TextLIME object

SetRegularization()

TextLIME Synapse.ML.Lime.TextLIME.SetRegularization

(

double

value

)

Sets value for regularization

Parameters

value

regularization param for the lasso

Returns

New TextLIME object

SetSamplingFraction()

TextLIME Synapse.ML.Lime.TextLIME.SetSamplingFraction

(

double

value

)

Sets value for samplingFraction

Parameters

value

The fraction of superpixels to keep on

Returns

New TextLIME object

SetTokenCol()

TextLIME Synapse.ML.Lime.TextLIME.SetTokenCol

(

string

value

)

Sets value for tokenCol

Parameters

value

The column holding the token

Returns

New TextLIME object

---

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

• synapse/ml/lime/TextLIME.cs