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

TabularLIMEModel implements TabularLIMEModel More...

Inheritance diagram for Synapse.ML.Lime.TabularLIMEModel:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Lime.TabularLIMEModel:
Collaboration graph
[legend]

Public Member Functions

 TabularLIMEModel ()
 Creates a TabularLIMEModel without any parameters. More...
 
 TabularLIMEModel (string uid)
 Creates a TabularLIMEModel with a UID that is used to give the TabularLIMEModel a unique ID. More...
 
TabularLIMEModel SetColumnSTDs (double[] value)
 Sets value for columnSTDs More...
 
TabularLIMEModel SetInputCol (string value)
 Sets value for inputCol More...
 
TabularLIMEModel SetModel (JavaTransformer value)
 Sets value for model More...
 
TabularLIMEModel SetNSamples (int value)
 Sets value for nSamples More...
 
TabularLIMEModel SetOutputCol (string value)
 Sets value for outputCol More...
 
TabularLIMEModel SetPredictionCol (string value)
 Sets value for predictionCol More...
 
TabularLIMEModel SetRegularization (double value)
 Sets value for regularization More...
 
TabularLIMEModel SetSamplingFraction (double value)
 Sets value for samplingFraction More...
 
double [] GetColumnSTDs ()
 Gets columnSTDs value 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...
 
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< TabularLIMEModelRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static TabularLIMEModel Load (string path)
 Loads the TabularLIMEModel that was previously saved using Save(string). More...
 

Detailed Description

TabularLIMEModel implements TabularLIMEModel

Constructor & Destructor Documentation

◆ TabularLIMEModel() [1/2]

Synapse.ML.Lime.TabularLIMEModel.TabularLIMEModel ( )
inline

Creates a TabularLIMEModel without any parameters.

◆ TabularLIMEModel() [2/2]

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

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

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

Member Function Documentation

◆ GetColumnSTDs()

double [] Synapse.ML.Lime.TabularLIMEModel.GetColumnSTDs ( )

Gets columnSTDs value

Returns
columnSTDs: the standard deviations of each of the columns for perturbation

◆ GetInputCol()

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

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetModel()

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

Gets model value

Returns
model: Model to try to locally approximate

◆ GetNSamples()

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

Gets nSamples value

Returns
nSamples: The number of samples to generate

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPredictionCol()

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

Gets predictionCol value

Returns
predictionCol: prediction column name

◆ GetRegularization()

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

Gets regularization value

Returns
regularization: regularization param for the lasso

◆ GetSamplingFraction()

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

Gets samplingFraction value

Returns
samplingFraction: The fraction of superpixels to keep on

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetColumnSTDs()

TabularLIMEModel Synapse.ML.Lime.TabularLIMEModel.SetColumnSTDs ( double []  value)

Sets value for columnSTDs

Parameters
valuethe standard deviations of each of the columns for perturbation
Returns
New TabularLIMEModel object

◆ SetInputCol()

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

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New TabularLIMEModel object

◆ SetModel()

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

Sets value for model

Parameters
valueModel to try to locally approximate
Returns
New TabularLIMEModel object

◆ SetNSamples()

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

Sets value for nSamples

Parameters
valueThe number of samples to generate
Returns
New TabularLIMEModel object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New TabularLIMEModel object

◆ SetPredictionCol()

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

Sets value for predictionCol

Parameters
valueprediction column name
Returns
New TabularLIMEModel object

◆ SetRegularization()

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

Sets value for regularization

Parameters
valueregularization param for the lasso
Returns
New TabularLIMEModel object

◆ SetSamplingFraction()

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

Sets value for samplingFraction

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

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