Synapse.ML.Causal.ResidualTransformer Class Reference

ResidualTransformer implements ResidualTransformer More...

Inheritance diagram for Synapse.ML.Causal.ResidualTransformer:

Collaboration diagram for Synapse.ML.Causal.ResidualTransformer:

Public Member Functions
	ResidualTransformer ()
	Creates a ResidualTransformer without any parameters. More...
	ResidualTransformer (string uid)
	Creates a ResidualTransformer with a UID that is used to give the ResidualTransformer a unique ID. More...
ResidualTransformer	SetClassIndex (int value)
	Sets value for classIndex More...
ResidualTransformer	SetObservedCol (string value)
	Sets value for observedCol More...
ResidualTransformer	SetOutputCol (string value)
	Sets value for outputCol More...
ResidualTransformer	SetPredictedCol (string value)
	Sets value for predictedCol More...
int	GetClassIndex ()
	Gets classIndex value More...
string	GetObservedCol ()
	Gets observedCol value More...
string	GetOutputCol ()
	Gets outputCol value More...
string	GetPredictedCol ()
	Gets predictedCol 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< ResidualTransformer >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

ResidualTransformer implements ResidualTransformer

Constructor & Destructor Documentation

ResidualTransformer() [1/2]

Synapse.ML.Causal.ResidualTransformer.ResidualTransformer ( )

inline

Creates a ResidualTransformer without any parameters.

ResidualTransformer() [2/2]

Synapse.ML.Causal.ResidualTransformer.ResidualTransformer ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetClassIndex()

int Synapse.ML.Causal.ResidualTransformer.GetClassIndex

(

)

Gets classIndex value

Returns

classIndex: The index of the class to compute residual for classification outputs. Default value is 1.

GetObservedCol()

string Synapse.ML.Causal.ResidualTransformer.GetObservedCol

(

)

Gets observedCol value

Returns

observedCol: observed data (label column)

GetOutputCol()

string Synapse.ML.Causal.ResidualTransformer.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPredictedCol()

string Synapse.ML.Causal.ResidualTransformer.GetPredictedCol

(

)

Gets predictedCol value

Returns

predictedCol: predicted data (prediction or probability columns

Load()

static ResidualTransformer Synapse.ML.Causal.ResidualTransformer.Load ( string  path )

static

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

Parameters

path	The path the previous ResidualTransformer was saved to

Returns

New ResidualTransformer object, loaded from path.

Read()

JavaMLReader<ResidualTransformer> Synapse.ML.Causal.ResidualTransformer.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<ResidualTransformer> instance for this ML instance.

Save()

void Synapse.ML.Causal.ResidualTransformer.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

SetClassIndex()

ResidualTransformer Synapse.ML.Causal.ResidualTransformer.SetClassIndex

(

int

value

)

Sets value for classIndex

Parameters

value

The index of the class to compute residual for classification outputs. Default value is 1.

Returns

New ResidualTransformer object

SetObservedCol()

ResidualTransformer Synapse.ML.Causal.ResidualTransformer.SetObservedCol

(

string

value

)

Sets value for observedCol

Parameters

value

observed data (label column)

Returns

New ResidualTransformer object

SetOutputCol()

ResidualTransformer Synapse.ML.Causal.ResidualTransformer.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New ResidualTransformer object

SetPredictedCol()

ResidualTransformer Synapse.ML.Causal.ResidualTransformer.SetPredictedCol

(

string

value

)

Sets value for predictedCol

Parameters

value

predicted data (prediction or probability columns

Returns

New ResidualTransformer object

---

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

• synapse/ml/causal/ResidualTransformer.cs