Synapseml  1.0.3
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Causal.OrthoForestVariableTransformer Class Reference

OrthoForestVariableTransformer implements OrthoForestVariableTransformer More...

Inheritance diagram for Synapse.ML.Causal.OrthoForestVariableTransformer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Causal.OrthoForestVariableTransformer:
Collaboration graph
[legend]

Public Member Functions

 OrthoForestVariableTransformer ()
 Creates a OrthoForestVariableTransformer without any parameters. More...
 
 OrthoForestVariableTransformer (string uid)
 Creates a OrthoForestVariableTransformer with a UID that is used to give the OrthoForestVariableTransformer a unique ID. More...
 
OrthoForestVariableTransformer SetOutcomeResidualCol (string value)
 Sets value for outcomeResidualCol More...
 
OrthoForestVariableTransformer SetOutputCol (string value)
 Sets value for outputCol More...
 
OrthoForestVariableTransformer SetTreatmentResidualCol (string value)
 Sets value for treatmentResidualCol More...
 
OrthoForestVariableTransformer SetWeightsCol (string value)
 Sets value for weightsCol More...
 
string GetOutcomeResidualCol ()
 Gets outcomeResidualCol value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetTreatmentResidualCol ()
 Gets treatmentResidualCol value More...
 
string GetWeightsCol ()
 Gets weightsCol 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< OrthoForestVariableTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

OrthoForestVariableTransformer implements OrthoForestVariableTransformer

Constructor & Destructor Documentation

◆ OrthoForestVariableTransformer() [1/2]

Synapse.ML.Causal.OrthoForestVariableTransformer.OrthoForestVariableTransformer ( )
inline

Creates a OrthoForestVariableTransformer without any parameters.

◆ OrthoForestVariableTransformer() [2/2]

Synapse.ML.Causal.OrthoForestVariableTransformer.OrthoForestVariableTransformer ( string  uid)
inline

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

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

Member Function Documentation

◆ GetOutcomeResidualCol()

string Synapse.ML.Causal.OrthoForestVariableTransformer.GetOutcomeResidualCol ( )

Gets outcomeResidualCol value

Returns
outcomeResidualCol: Outcome Residual Col

◆ GetOutputCol()

string Synapse.ML.Causal.OrthoForestVariableTransformer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetTreatmentResidualCol()

string Synapse.ML.Causal.OrthoForestVariableTransformer.GetTreatmentResidualCol ( )

Gets treatmentResidualCol value

Returns
treatmentResidualCol: Treatment Residual Col

◆ GetWeightsCol()

string Synapse.ML.Causal.OrthoForestVariableTransformer.GetWeightsCol ( )

Gets weightsCol value

Returns
weightsCol: Weights Col

◆ Load()

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

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

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

◆ Read()

JavaMLReader<OrthoForestVariableTransformer> Synapse.ML.Causal.OrthoForestVariableTransformer.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetOutcomeResidualCol()

OrthoForestVariableTransformer Synapse.ML.Causal.OrthoForestVariableTransformer.SetOutcomeResidualCol ( string  value)

Sets value for outcomeResidualCol

Parameters
valueOutcome Residual Col
Returns
New OrthoForestVariableTransformer object

◆ SetOutputCol()

OrthoForestVariableTransformer Synapse.ML.Causal.OrthoForestVariableTransformer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New OrthoForestVariableTransformer object

◆ SetTreatmentResidualCol()

OrthoForestVariableTransformer Synapse.ML.Causal.OrthoForestVariableTransformer.SetTreatmentResidualCol ( string  value)

Sets value for treatmentResidualCol

Parameters
valueTreatment Residual Col
Returns
New OrthoForestVariableTransformer object

◆ SetWeightsCol()

OrthoForestVariableTransformer Synapse.ML.Causal.OrthoForestVariableTransformer.SetWeightsCol ( string  value)

Sets value for weightsCol

Parameters
valueWeights Col
Returns
New OrthoForestVariableTransformer object

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