Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Lime.TabularLIME Class Reference

TabularLIME implements TabularLIME More...

Inheritance diagram for Synapse.ML.Lime.TabularLIME:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Lime.TabularLIME:
Collaboration graph
[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 SetInputCol (string value)
 Sets value for inputCol More...
 
TabularLIME SetModel (JavaTransformer value)
 Sets value for model More...
 
TabularLIME SetNSamples (int value)
 Sets value for nSamples More...
 
TabularLIME SetOutputCol (string value)
 Sets value for outputCol More...
 
TabularLIME SetPredictionCol (string value)
 Sets value for predictionCol More...
 
TabularLIME SetRegularization (double value)
 Sets value for regularization More...
 
TabularLIME SetSamplingFraction (double value)
 Sets value for samplingFraction 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...
 
override TabularLIMEModel Fit (DataFrame dataset)
 Fits a model to the input data. 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< TabularLIMERead ()
 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.Lime.TabularLIME.TabularLIME ( )
inline

Creates a TabularLIME without any parameters.

◆ TabularLIME() [2/2]

Synapse.ML.Lime.TabularLIME.TabularLIME ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ Fit()

override TabularLIMEModel Synapse.ML.Lime.TabularLIME.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
TabularLIMEModel

◆ GetInputCol()

string Synapse.ML.Lime.TabularLIME.GetInputCol ( )

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetModel()

JavaTransformer Synapse.ML.Lime.TabularLIME.GetModel ( )
inline

Gets model value

Returns
model: Model to try to locally approximate

◆ GetNSamples()

int Synapse.ML.Lime.TabularLIME.GetNSamples ( )

Gets nSamples value

Returns
nSamples: The number of samples to generate

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPredictionCol()

string Synapse.ML.Lime.TabularLIME.GetPredictionCol ( )

Gets predictionCol value

Returns
predictionCol: prediction column name

◆ GetRegularization()

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

Gets regularization value

Returns
regularization: regularization param for the lasso

◆ GetSamplingFraction()

double Synapse.ML.Lime.TabularLIME.GetSamplingFraction ( )

Gets samplingFraction value

Returns
samplingFraction: The fraction of superpixels to keep on

◆ Load()

static TabularLIME Synapse.ML.Lime.TabularLIME.Load ( string  path)
static

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

Parameters
pathThe path the previous TabularLIME was saved to
Returns
New TabularLIME object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Lime.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
pathThe path to save the object to

◆ SetInputCol()

TabularLIME Synapse.ML.Lime.TabularLIME.SetInputCol ( string  value)

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New TabularLIME object

◆ SetModel()

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

Sets value for model

Parameters
valueModel to try to locally approximate
Returns
New TabularLIME object

◆ SetNSamples()

TabularLIME Synapse.ML.Lime.TabularLIME.SetNSamples ( int  value)

Sets value for nSamples

Parameters
valueThe number of samples to generate
Returns
New TabularLIME object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New TabularLIME object

◆ SetPredictionCol()

TabularLIME Synapse.ML.Lime.TabularLIME.SetPredictionCol ( string  value)

Sets value for predictionCol

Parameters
valueprediction column name
Returns
New TabularLIME object

◆ SetRegularization()

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

Sets value for regularization

Parameters
valueregularization param for the lasso
Returns
New TabularLIME object

◆ SetSamplingFraction()

TabularLIME Synapse.ML.Lime.TabularLIME.SetSamplingFraction ( double  value)

Sets value for samplingFraction

Parameters
valueThe fraction of superpixels to keep on
Returns
New TabularLIME object

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