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

ImageLIME implements ImageLIME More...

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

Public Member Functions

 ImageLIME ()
 Creates a ImageLIME without any parameters. More...
 
 ImageLIME (string uid)
 Creates a ImageLIME with a UID that is used to give the ImageLIME a unique ID. More...
 
ImageLIME SetCellSize (double value)
 Sets value for cellSize More...
 
ImageLIME SetInputCol (string value)
 Sets value for inputCol More...
 
ImageLIME SetModel (JavaTransformer value)
 Sets value for model More...
 
ImageLIME SetModifier (double value)
 Sets value for modifier More...
 
ImageLIME SetNSamples (int value)
 Sets value for nSamples More...
 
ImageLIME SetOutputCol (string value)
 Sets value for outputCol More...
 
ImageLIME SetPredictionCol (string value)
 Sets value for predictionCol More...
 
ImageLIME SetRegularization (double value)
 Sets value for regularization More...
 
ImageLIME SetSamplingFraction (double value)
 Sets value for samplingFraction More...
 
ImageLIME SetSuperpixelCol (string value)
 Sets value for superpixelCol More...
 
double GetCellSize ()
 Gets cellSize value More...
 
string GetInputCol ()
 Gets inputCol value More...
 
JavaTransformer GetModel ()
 Gets model value More...
 
double GetModifier ()
 Gets modifier 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 GetSuperpixelCol ()
 Gets superpixelCol 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< ImageLIMERead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ImageLIME implements ImageLIME

Constructor & Destructor Documentation

◆ ImageLIME() [1/2]

Synapse.ML.Lime.ImageLIME.ImageLIME ( )
inline

Creates a ImageLIME without any parameters.

◆ ImageLIME() [2/2]

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

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

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

Member Function Documentation

◆ GetCellSize()

double Synapse.ML.Lime.ImageLIME.GetCellSize ( )

Gets cellSize value

Returns
cellSize: Number that controls the size of the superpixels

◆ GetInputCol()

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

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetModel()

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

Gets model value

Returns
model: Model to try to locally approximate

◆ GetModifier()

double Synapse.ML.Lime.ImageLIME.GetModifier ( )

Gets modifier value

Returns
modifier: Controls the trade-off spatial and color distance

◆ GetNSamples()

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

Gets nSamples value

Returns
nSamples: The number of samples to generate

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPredictionCol()

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

Gets predictionCol value

Returns
predictionCol: prediction column name

◆ GetRegularization()

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

Gets regularization value

Returns
regularization: regularization param for the lasso

◆ GetSamplingFraction()

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

Gets samplingFraction value

Returns
samplingFraction: The fraction of superpixels to keep on

◆ GetSuperpixelCol()

string Synapse.ML.Lime.ImageLIME.GetSuperpixelCol ( )

Gets superpixelCol value

Returns
superpixelCol: The column holding the superpixel decompositions

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetCellSize()

ImageLIME Synapse.ML.Lime.ImageLIME.SetCellSize ( double  value)

Sets value for cellSize

Parameters
valueNumber that controls the size of the superpixels
Returns
New ImageLIME object

◆ SetInputCol()

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

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New ImageLIME object

◆ SetModel()

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

Sets value for model

Parameters
valueModel to try to locally approximate
Returns
New ImageLIME object

◆ SetModifier()

ImageLIME Synapse.ML.Lime.ImageLIME.SetModifier ( double  value)

Sets value for modifier

Parameters
valueControls the trade-off spatial and color distance
Returns
New ImageLIME object

◆ SetNSamples()

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

Sets value for nSamples

Parameters
valueThe number of samples to generate
Returns
New ImageLIME object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ImageLIME object

◆ SetPredictionCol()

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

Sets value for predictionCol

Parameters
valueprediction column name
Returns
New ImageLIME object

◆ SetRegularization()

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

Sets value for regularization

Parameters
valueregularization param for the lasso
Returns
New ImageLIME object

◆ SetSamplingFraction()

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

Sets value for samplingFraction

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

◆ SetSuperpixelCol()

ImageLIME Synapse.ML.Lime.ImageLIME.SetSuperpixelCol ( string  value)

Sets value for superpixelCol

Parameters
valueThe column holding the superpixel decompositions
Returns
New ImageLIME object

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