Inheritance diagram for Synapse.ML.Explainers.ImageSHAP:

[legend]

Collaboration diagram for Synapse.ML.Explainers.ImageSHAP:

[legend]

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

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

ImageSHAP	SetCellSize (double value)
	Sets value for cellSize More...

ImageSHAP	SetInfWeight (double value)
	Sets value for infWeight More...

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

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

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

ImageSHAP	SetModifier (double value)
	Sets value for modifier More...

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

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

ImageSHAP	SetSuperpixelCol (string value)
	Sets value for superpixelCol More...

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

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

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

double	GetCellSize ()
	Gets cellSize value More...

double	GetInfWeight ()
	Gets infWeight value More...

string	GetInputCol ()
	Gets inputCol value More...

string	GetMetricsCol ()
	Gets metricsCol value More...

JavaTransformer	GetModel ()
	Gets model value More...

double	GetModifier ()
	Gets modifier value More...

int	GetNumSamples ()
	Gets numSamples value More...

string	GetOutputCol ()
	Gets outputCol value More...

string	GetSuperpixelCol ()
	Gets superpixelCol value More...

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

string	GetTargetClassesCol ()
	Gets targetClassesCol value More...

string	GetTargetCol ()
	Gets targetCol 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< ImageSHAP >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

ImageSHAP implements ImageSHAP

Constructor & Destructor Documentation

◆ ImageSHAP() [1/2]

Synapse.ML.Explainers.ImageSHAP.ImageSHAP ( )

inline

Creates a ImageSHAP without any parameters.

◆ ImageSHAP() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetCellSize()

double Synapse.ML.Explainers.ImageSHAP.GetCellSize ( )

Gets cellSize value

Returns: cellSize: Number that controls the size of the superpixels

◆ GetInfWeight()

double Synapse.ML.Explainers.ImageSHAP.GetInfWeight ( )

Gets infWeight value

Returns: infWeight: The double value to represent infinite weight. Default: 1E8.

◆ GetInputCol()

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

Gets inputCol value

Returns: inputCol: input column name

◆ GetMetricsCol()

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

Gets metricsCol value

Returns: metricsCol: Column name for fitting metrics

◆ GetModel()

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

inline

Gets model value

Returns: model: The model to be interpreted.

◆ GetModifier()

double Synapse.ML.Explainers.ImageSHAP.GetModifier ( )

Gets modifier value

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

◆ GetNumSamples()

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

Gets numSamples value

Returns: numSamples: Number of samples to generate.

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: output column name

◆ GetSuperpixelCol()

string Synapse.ML.Explainers.ImageSHAP.GetSuperpixelCol ( )

Gets superpixelCol value

Returns: superpixelCol: The column holding the superpixel decompositions

◆ GetTargetClasses()

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

◆ Load()

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

static

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

Parameters

path	The path the previous ImageSHAP was saved to

Returns: New ImageSHAP object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetCellSize()

ImageSHAP Synapse.ML.Explainers.ImageSHAP.SetCellSize ( double value )

Sets value for cellSize

Parameters

value Number that controls the size of the superpixels

Returns: New ImageSHAP object

◆ SetInfWeight()

ImageSHAP Synapse.ML.Explainers.ImageSHAP.SetInfWeight ( double value )

Sets value for infWeight

Parameters

value The double value to represent infinite weight. Default: 1E8.

Returns: New ImageSHAP object

◆ SetInputCol()

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

Sets value for inputCol

Parameters

value input column name

Returns: New ImageSHAP object

◆ SetMetricsCol()

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

Sets value for metricsCol

Parameters

value Column name for fitting metrics

Returns: New ImageSHAP object

◆ SetModel()

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

Sets value for model

Parameters

value The model to be interpreted.

Returns: New ImageSHAP object

◆ SetModifier()

ImageSHAP Synapse.ML.Explainers.ImageSHAP.SetModifier ( double value )

Sets value for modifier

Parameters

value Controls the trade-off spatial and color distance

Returns: New ImageSHAP object

◆ SetNumSamples()

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

Sets value for numSamples

Parameters

value Number of samples to generate.

Returns: New ImageSHAP object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value output column name

Returns: New ImageSHAP object

◆ SetSuperpixelCol()

ImageSHAP Synapse.ML.Explainers.ImageSHAP.SetSuperpixelCol ( string value )

Sets value for superpixelCol

Parameters

value The column holding the superpixel decompositions

Returns: New ImageSHAP object

◆ SetTargetClasses()

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

◆ SetTargetClassesCol()

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

◆ SetTargetCol()

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

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

synapse/ml/explainers/ImageSHAP.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ImageSHAP() [1/2]

◆ ImageSHAP() [2/2]

Member Function Documentation

◆ GetCellSize()

◆ GetInfWeight()

◆ GetInputCol()

◆ GetMetricsCol()

◆ GetModel()

◆ GetModifier()

◆ GetNumSamples()

◆ GetOutputCol()

◆ GetSuperpixelCol()

◆ GetTargetClasses()

◆ GetTargetClassesCol()

◆ GetTargetCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetCellSize()

◆ SetInfWeight()

◆ SetInputCol()

◆ SetMetricsCol()

◆ SetModel()

◆ SetModifier()

◆ SetNumSamples()

◆ SetOutputCol()

◆ SetSuperpixelCol()

◆ SetTargetClasses()

◆ SetTargetClassesCol()

◆ SetTargetCol()