Synapse.ML.Causal.OrthoForestDMLModel Class Reference

OrthoForestDMLModel implements OrthoForestDMLModel More...

Inheritance diagram for Synapse.ML.Causal.OrthoForestDMLModel:

Collaboration diagram for Synapse.ML.Causal.OrthoForestDMLModel:

Public Member Functions
	OrthoForestDMLModel ()
	Creates a OrthoForestDMLModel without any parameters. More...
	OrthoForestDMLModel (string uid)
	Creates a OrthoForestDMLModel with a UID that is used to give the OrthoForestDMLModel a unique ID. More...
OrthoForestDMLModel	SetConfidenceLevel (double value)
	Sets value for confidenceLevel More...
OrthoForestDMLModel	SetConfounderVecCol (string value)
	Sets value for confounderVecCol More...
OrthoForestDMLModel	SetFeaturesCol (string value)
	Sets value for featuresCol More...
OrthoForestDMLModel	SetForest (JavaTransformer[] value)
	Sets value for forest More...
OrthoForestDMLModel	SetHeterogeneityVecCol (string value)
	Sets value for heterogeneityVecCol More...
OrthoForestDMLModel	SetMaxDepth (int value)
	Sets value for maxDepth More...
OrthoForestDMLModel	SetMaxIter (int value)
	Sets value for maxIter More...
OrthoForestDMLModel	SetMinSamplesLeaf (int value)
	Sets value for minSamplesLeaf More...
OrthoForestDMLModel	SetNumTrees (int value)
	Sets value for numTrees More...
OrthoForestDMLModel	SetOutcomeCol (string value)
	Sets value for outcomeCol More...
OrthoForestDMLModel	SetOutcomeModel< M > (JavaEstimator< M > value)
	Sets value for outcomeModel More...
OrthoForestDMLModel	SetOutcomeResidualCol (string value)
	Sets value for outcomeResidualCol More...
OrthoForestDMLModel	SetOutputCol (string value)
	Sets value for outputCol More...
OrthoForestDMLModel	SetOutputHighCol (string value)
	Sets value for outputHighCol More...
OrthoForestDMLModel	SetOutputLowCol (string value)
	Sets value for outputLowCol More...
OrthoForestDMLModel	SetParallelism (int value)
	Sets value for parallelism More...
OrthoForestDMLModel	SetSampleSplitRatio (double[] value)
	Sets value for sampleSplitRatio More...
OrthoForestDMLModel	SetTreatmentCol (string value)
	Sets value for treatmentCol More...
OrthoForestDMLModel	SetTreatmentModel< M > (JavaEstimator< M > value)
	Sets value for treatmentModel More...
OrthoForestDMLModel	SetTreatmentResidualCol (string value)
	Sets value for treatmentResidualCol More...
OrthoForestDMLModel	SetWeightCol (string value)
	Sets value for weightCol More...
double	GetConfidenceLevel ()
	Gets confidenceLevel value More...
string	GetConfounderVecCol ()
	Gets confounderVecCol value More...
string	GetFeaturesCol ()
	Gets featuresCol value More...
JavaTransformer[]	GetForest ()
	Gets forest value More...
string	GetHeterogeneityVecCol ()
	Gets heterogeneityVecCol value More...
int	GetMaxDepth ()
	Gets maxDepth value More...
int	GetMaxIter ()
	Gets maxIter value More...
int	GetMinSamplesLeaf ()
	Gets minSamplesLeaf value More...
int	GetNumTrees ()
	Gets numTrees value More...
string	GetOutcomeCol ()
	Gets outcomeCol value More...
IEstimator< object >	GetOutcomeModel ()
	Gets outcomeModel value More...
string	GetOutcomeResidualCol ()
	Gets outcomeResidualCol value More...
string	GetOutputCol ()
	Gets outputCol value More...
string	GetOutputHighCol ()
	Gets outputHighCol value More...
string	GetOutputLowCol ()
	Gets outputLowCol value More...
int	GetParallelism ()
	Gets parallelism value More...
double[]	GetSampleSplitRatio ()
	Gets sampleSplitRatio value More...
string	GetTreatmentCol ()
	Gets treatmentCol value More...
IEstimator< object >	GetTreatmentModel ()
	Gets treatmentModel value More...
string	GetTreatmentResidualCol ()
	Gets treatmentResidualCol value More...
string	GetWeightCol ()
	Gets weightCol 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< OrthoForestDMLModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

OrthoForestDMLModel implements OrthoForestDMLModel

Constructor & Destructor Documentation

OrthoForestDMLModel() [1/2]

Synapse.ML.Causal.OrthoForestDMLModel.OrthoForestDMLModel ( )

inline

Creates a OrthoForestDMLModel without any parameters.

OrthoForestDMLModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetConfidenceLevel()

double Synapse.ML.Causal.OrthoForestDMLModel.GetConfidenceLevel

(

)

Gets confidenceLevel value

Returns

confidenceLevel: confidence level, default value is 0.975

GetConfounderVecCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetConfounderVecCol

(

)

Gets confounderVecCol value

Returns

confounderVecCol: Confounders to control for

GetFeaturesCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetFeaturesCol

(

)

Gets featuresCol value

Returns

featuresCol: The name of the features column

GetForest()

JavaTransformer [] Synapse.ML.Causal.OrthoForestDMLModel.GetForest ( )

inline

Gets forest value

Returns

forest: Forest Trees produced in Ortho Forest DML Estimator

GetHeterogeneityVecCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetHeterogeneityVecCol

(

)

Gets heterogeneityVecCol value

Returns

heterogeneityVecCol: Vector to divide the treatment by

GetMaxDepth()

int Synapse.ML.Causal.OrthoForestDMLModel.GetMaxDepth

(

)

Gets maxDepth value

Returns

maxDepth: Max Depth of Tree

GetMaxIter()

int Synapse.ML.Causal.OrthoForestDMLModel.GetMaxIter

(

)

Gets maxIter value

Returns

maxIter: maximum number of iterations (>= 0)

GetMinSamplesLeaf()

int Synapse.ML.Causal.OrthoForestDMLModel.GetMinSamplesLeaf

(

)

Gets minSamplesLeaf value

Returns

minSamplesLeaf: Max Depth of Tree

GetNumTrees()

int Synapse.ML.Causal.OrthoForestDMLModel.GetNumTrees

(

)

Gets numTrees value

Returns

numTrees: Number of trees

GetOutcomeCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetOutcomeCol

(

)

Gets outcomeCol value

Returns

outcomeCol: outcome column

GetOutcomeModel()

IEstimator<object> Synapse.ML.Causal.OrthoForestDMLModel.GetOutcomeModel ( )

inline

Gets outcomeModel value

Returns

outcomeModel: outcome model to run

GetOutcomeResidualCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetOutcomeResidualCol

(

)

Gets outcomeResidualCol value

Returns

outcomeResidualCol: Outcome Residual Column

GetOutputCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetOutputHighCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetOutputHighCol

(

)

Gets outputHighCol value

Returns

outputHighCol: Output Confidence Interval Low

GetOutputLowCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetOutputLowCol

(

)

Gets outputLowCol value

Returns

outputLowCol: Output Confidence Interval Low

GetParallelism()

int Synapse.ML.Causal.OrthoForestDMLModel.GetParallelism

(

)

Gets parallelism value

Returns

parallelism: the number of threads to use when running parallel algorithms

GetSampleSplitRatio()

double [] Synapse.ML.Causal.OrthoForestDMLModel.GetSampleSplitRatio

(

)

Gets sampleSplitRatio value

Returns

sampleSplitRatio: Sample split ratio for cross-fitting. Default: [0.5, 0.5].

GetTreatmentCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetTreatmentCol

(

)

Gets treatmentCol value

Returns

treatmentCol: treatment column

GetTreatmentModel()

IEstimator<object> Synapse.ML.Causal.OrthoForestDMLModel.GetTreatmentModel ( )

inline

Gets treatmentModel value

Returns

treatmentModel: treatment model to run

GetTreatmentResidualCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetTreatmentResidualCol

(

)

Gets treatmentResidualCol value

Returns

treatmentResidualCol: Treatment Residual Column

GetWeightCol()

string Synapse.ML.Causal.OrthoForestDMLModel.GetWeightCol

(

)

Gets weightCol value

Returns

weightCol: The name of the weight column

Load()

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

static

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

Parameters

path	The path the previous OrthoForestDMLModel was saved to

Returns

New OrthoForestDMLModel object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<OrthoForestDMLModel> instance for this ML instance.

Save()

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

SetConfidenceLevel()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetConfidenceLevel

(

double

value

)

Sets value for confidenceLevel

Parameters

value

confidence level, default value is 0.975

Returns

New OrthoForestDMLModel object

SetConfounderVecCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetConfounderVecCol

(

string

value

)

Sets value for confounderVecCol

Parameters

value

Confounders to control for

Returns

New OrthoForestDMLModel object

SetFeaturesCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetFeaturesCol

(

string

value

)

Sets value for featuresCol

Parameters

value

The name of the features column

Returns

New OrthoForestDMLModel object

SetForest()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetForest

(

JavaTransformer[]

value

)

Sets value for forest

Parameters

value

Forest Trees produced in Ortho Forest DML Estimator

Returns

New OrthoForestDMLModel object

SetHeterogeneityVecCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetHeterogeneityVecCol

(

string

value

)

Sets value for heterogeneityVecCol

Parameters

value

Vector to divide the treatment by

Returns

New OrthoForestDMLModel object

SetMaxDepth()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetMaxDepth

(

int

value

)

Sets value for maxDepth

Parameters

value

Max Depth of Tree

Returns

New OrthoForestDMLModel object

SetMaxIter()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetMaxIter

(

int

value

)

Sets value for maxIter

Parameters

value

maximum number of iterations (>= 0)

Returns

New OrthoForestDMLModel object

SetMinSamplesLeaf()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetMinSamplesLeaf

(

int

value

)

Sets value for minSamplesLeaf

Parameters

value

Max Depth of Tree

Returns

New OrthoForestDMLModel object

SetNumTrees()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetNumTrees

(

int

value

)

Sets value for numTrees

Parameters

value

Number of trees

Returns

New OrthoForestDMLModel object

SetOutcomeCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetOutcomeCol

(

string

value

)

Sets value for outcomeCol

Parameters

value

outcome column

Returns

New OrthoForestDMLModel object

SetOutcomeModel< M >()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetOutcomeModel< M >

(

JavaEstimator< M >

value

)

Sets value for outcomeModel

Parameters

value

outcome model to run

Returns

New OrthoForestDMLModel object

Type Constraints

M	:	JavaModel<M>
M	:	WrapAsOrthoForestDMLModel
M	:	Reference.Invoke
M	:	setOutcomeModel
M	:	object
M	:	value

SetOutcomeResidualCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetOutcomeResidualCol

(

string

value

)

Sets value for outcomeResidualCol

Parameters

value

Outcome Residual Column

Returns

New OrthoForestDMLModel object

SetOutputCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New OrthoForestDMLModel object

SetOutputHighCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetOutputHighCol

(

string

value

)

Sets value for outputHighCol

Parameters

value

Output Confidence Interval Low

Returns

New OrthoForestDMLModel object

SetOutputLowCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetOutputLowCol

(

string

value

)

Sets value for outputLowCol

Parameters

value

Output Confidence Interval Low

Returns

New OrthoForestDMLModel object

SetParallelism()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetParallelism

(

int

value

)

Sets value for parallelism

Parameters

value

the number of threads to use when running parallel algorithms

Returns

New OrthoForestDMLModel object

SetSampleSplitRatio()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetSampleSplitRatio

(

double[]

value

)

Sets value for sampleSplitRatio

Parameters

value

Sample split ratio for cross-fitting. Default: [0.5, 0.5].

Returns

New OrthoForestDMLModel object

SetTreatmentCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetTreatmentCol

(

string

value

)

Sets value for treatmentCol

Parameters

value

treatment column

Returns

New OrthoForestDMLModel object

SetTreatmentModel< M >()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetTreatmentModel< M >

(

JavaEstimator< M >

value

)

Sets value for treatmentModel

Parameters

value

treatment model to run

Returns

New OrthoForestDMLModel object

Type Constraints

M	:	JavaModel<M>
M	:	WrapAsOrthoForestDMLModel
M	:	Reference.Invoke
M	:	setTreatmentModel
M	:	object
M	:	value

SetTreatmentResidualCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetTreatmentResidualCol

(

string

value

)

Sets value for treatmentResidualCol

Parameters

value

Treatment Residual Column

Returns

New OrthoForestDMLModel object

SetWeightCol()

OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLModel.SetWeightCol

(

string

value

)

Sets value for weightCol

Parameters

value

The name of the weight column

Returns

New OrthoForestDMLModel object

---

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

• synapse/ml/causal/OrthoForestDMLModel.cs