Synapse.ML.Causal.OrthoForestDMLEstimator Class Reference

OrthoForestDMLEstimator implements OrthoForestDMLEstimator More...

Inheritance diagram for Synapse.ML.Causal.OrthoForestDMLEstimator:

Collaboration diagram for Synapse.ML.Causal.OrthoForestDMLEstimator:

Public Member Functions
	OrthoForestDMLEstimator ()
	Creates a OrthoForestDMLEstimator without any parameters. More...
	OrthoForestDMLEstimator (string uid)
	Creates a OrthoForestDMLEstimator with a UID that is used to give the OrthoForestDMLEstimator a unique ID. More...
OrthoForestDMLEstimator	SetConfidenceLevel (double value)
	Sets value for confidenceLevel More...
OrthoForestDMLEstimator	SetConfounderVecCol (string value)
	Sets value for confounderVecCol More...
OrthoForestDMLEstimator	SetFeaturesCol (string value)
	Sets value for featuresCol More...
OrthoForestDMLEstimator	SetHeterogeneityVecCol (string value)
	Sets value for heterogeneityVecCol More...
OrthoForestDMLEstimator	SetMaxDepth (int value)
	Sets value for maxDepth More...
OrthoForestDMLEstimator	SetMaxIter (int value)
	Sets value for maxIter More...
OrthoForestDMLEstimator	SetMinSamplesLeaf (int value)
	Sets value for minSamplesLeaf More...
OrthoForestDMLEstimator	SetNumTrees (int value)
	Sets value for numTrees More...
OrthoForestDMLEstimator	SetOutcomeCol (string value)
	Sets value for outcomeCol More...
OrthoForestDMLEstimator	SetOutcomeModel< M > (JavaEstimator< M > value)
	Sets value for outcomeModel More...
OrthoForestDMLEstimator	SetOutcomeResidualCol (string value)
	Sets value for outcomeResidualCol More...
OrthoForestDMLEstimator	SetOutputCol (string value)
	Sets value for outputCol More...
OrthoForestDMLEstimator	SetOutputHighCol (string value)
	Sets value for outputHighCol More...
OrthoForestDMLEstimator	SetOutputLowCol (string value)
	Sets value for outputLowCol More...
OrthoForestDMLEstimator	SetParallelism (int value)
	Sets value for parallelism More...
OrthoForestDMLEstimator	SetSampleSplitRatio (double[] value)
	Sets value for sampleSplitRatio More...
OrthoForestDMLEstimator	SetTreatmentCol (string value)
	Sets value for treatmentCol More...
OrthoForestDMLEstimator	SetTreatmentModel< M > (JavaEstimator< M > value)
	Sets value for treatmentModel More...
OrthoForestDMLEstimator	SetTreatmentResidualCol (string value)
	Sets value for treatmentResidualCol More...
OrthoForestDMLEstimator	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...
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...
override OrthoForestDMLModel	Fit (DataFrame dataset)
	Fits a model to the input data. 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< OrthoForestDMLEstimator >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

OrthoForestDMLEstimator implements OrthoForestDMLEstimator

Constructor & Destructor Documentation

OrthoForestDMLEstimator() [1/2]

Synapse.ML.Causal.OrthoForestDMLEstimator.OrthoForestDMLEstimator ( )

inline

Creates a OrthoForestDMLEstimator without any parameters.

OrthoForestDMLEstimator() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

Fit()

override OrthoForestDMLModel Synapse.ML.Causal.OrthoForestDMLEstimator.Fit

(

DataFrame

dataset

)

Fits a model to the input data.

Parameters

dataset

The DataFrame to fit the model to.

Returns

OrthoForestDMLModel

GetConfidenceLevel()

double Synapse.ML.Causal.OrthoForestDMLEstimator.GetConfidenceLevel

(

)

Gets confidenceLevel value

Returns

confidenceLevel: confidence level, default value is 0.975

GetConfounderVecCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetConfounderVecCol

(

)

Gets confounderVecCol value

Returns

confounderVecCol: Confounders to control for

GetFeaturesCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetFeaturesCol

(

)

Gets featuresCol value

Returns

featuresCol: The name of the features column

GetHeterogeneityVecCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetHeterogeneityVecCol

(

)

Gets heterogeneityVecCol value

Returns

heterogeneityVecCol: Vector to divide the treatment by

GetMaxDepth()

int Synapse.ML.Causal.OrthoForestDMLEstimator.GetMaxDepth

(

)

Gets maxDepth value

Returns

maxDepth: Max Depth of Tree

GetMaxIter()

int Synapse.ML.Causal.OrthoForestDMLEstimator.GetMaxIter

(

)

Gets maxIter value

Returns

maxIter: maximum number of iterations (>= 0)

GetMinSamplesLeaf()

int Synapse.ML.Causal.OrthoForestDMLEstimator.GetMinSamplesLeaf

(

)

Gets minSamplesLeaf value

Returns

minSamplesLeaf: Max Depth of Tree

GetNumTrees()

int Synapse.ML.Causal.OrthoForestDMLEstimator.GetNumTrees

(

)

Gets numTrees value

Returns

numTrees: Number of trees

GetOutcomeCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetOutcomeCol

(

)

Gets outcomeCol value

Returns

outcomeCol: outcome column

GetOutcomeModel()

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

inline

Gets outcomeModel value

Returns

outcomeModel: outcome model to run

GetOutcomeResidualCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetOutcomeResidualCol

(

)

Gets outcomeResidualCol value

Returns

outcomeResidualCol: Outcome Residual Column

GetOutputCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetOutputHighCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetOutputHighCol

(

)

Gets outputHighCol value

Returns

outputHighCol: Output Confidence Interval Low

GetOutputLowCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetOutputLowCol

(

)

Gets outputLowCol value

Returns

outputLowCol: Output Confidence Interval Low

GetParallelism()

int Synapse.ML.Causal.OrthoForestDMLEstimator.GetParallelism

(

)

Gets parallelism value

Returns

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

GetSampleSplitRatio()

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

(

)

Gets sampleSplitRatio value

Returns

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

GetTreatmentCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetTreatmentCol

(

)

Gets treatmentCol value

Returns

treatmentCol: treatment column

GetTreatmentModel()

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

inline

Gets treatmentModel value

Returns

treatmentModel: treatment model to run

GetTreatmentResidualCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetTreatmentResidualCol

(

)

Gets treatmentResidualCol value

Returns

treatmentResidualCol: Treatment Residual Column

GetWeightCol()

string Synapse.ML.Causal.OrthoForestDMLEstimator.GetWeightCol

(

)

Gets weightCol value

Returns

weightCol: The name of the weight column

Load()

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

static

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

Parameters

path	The path the previous OrthoForestDMLEstimator was saved to

Returns

New OrthoForestDMLEstimator object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<OrthoForestDMLEstimator> instance for this ML instance.

Save()

void Synapse.ML.Causal.OrthoForestDMLEstimator.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()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetConfidenceLevel

(

double

value

)

Sets value for confidenceLevel

Parameters

value

confidence level, default value is 0.975

Returns

New OrthoForestDMLEstimator object

SetConfounderVecCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetConfounderVecCol

(

string

value

)

Sets value for confounderVecCol

Parameters

value

Confounders to control for

Returns

New OrthoForestDMLEstimator object

SetFeaturesCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetFeaturesCol

(

string

value

)

Sets value for featuresCol

Parameters

value

The name of the features column

Returns

New OrthoForestDMLEstimator object

SetHeterogeneityVecCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetHeterogeneityVecCol

(

string

value

)

Sets value for heterogeneityVecCol

Parameters

value

Vector to divide the treatment by

Returns

New OrthoForestDMLEstimator object

SetMaxDepth()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetMaxDepth

(

int

value

)

Sets value for maxDepth

Parameters

value

Max Depth of Tree

Returns

New OrthoForestDMLEstimator object

SetMaxIter()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetMaxIter

(

int

value

)

Sets value for maxIter

Parameters

value

maximum number of iterations (>= 0)

Returns

New OrthoForestDMLEstimator object

SetMinSamplesLeaf()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetMinSamplesLeaf

(

int

value

)

Sets value for minSamplesLeaf

Parameters

value

Max Depth of Tree

Returns

New OrthoForestDMLEstimator object

SetNumTrees()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetNumTrees

(

int

value

)

Sets value for numTrees

Parameters

value

Number of trees

Returns

New OrthoForestDMLEstimator object

SetOutcomeCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetOutcomeCol

(

string

value

)

Sets value for outcomeCol

Parameters

value

outcome column

Returns

New OrthoForestDMLEstimator object

SetOutcomeModel< M >()

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

(

JavaEstimator< M >

value

)

Sets value for outcomeModel

Parameters

value

outcome model to run

Returns

New OrthoForestDMLEstimator object

Type Constraints

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

SetOutcomeResidualCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetOutcomeResidualCol

(

string

value

)

Sets value for outcomeResidualCol

Parameters

value

Outcome Residual Column

Returns

New OrthoForestDMLEstimator object

SetOutputCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New OrthoForestDMLEstimator object

SetOutputHighCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetOutputHighCol

(

string

value

)

Sets value for outputHighCol

Parameters

value

Output Confidence Interval Low

Returns

New OrthoForestDMLEstimator object

SetOutputLowCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetOutputLowCol

(

string

value

)

Sets value for outputLowCol

Parameters

value

Output Confidence Interval Low

Returns

New OrthoForestDMLEstimator object

SetParallelism()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetParallelism

(

int

value

)

Sets value for parallelism

Parameters

value

the number of threads to use when running parallel algorithms

Returns

New OrthoForestDMLEstimator object

SetSampleSplitRatio()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetSampleSplitRatio

(

double[]

value

)

Sets value for sampleSplitRatio

Parameters

value

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

Returns

New OrthoForestDMLEstimator object

SetTreatmentCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetTreatmentCol

(

string

value

)

Sets value for treatmentCol

Parameters

value

treatment column

Returns

New OrthoForestDMLEstimator object

SetTreatmentModel< M >()

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

(

JavaEstimator< M >

value

)

Sets value for treatmentModel

Parameters

value

treatment model to run

Returns

New OrthoForestDMLEstimator object

Type Constraints

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

SetTreatmentResidualCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetTreatmentResidualCol

(

string

value

)

Sets value for treatmentResidualCol

Parameters

value

Treatment Residual Column

Returns

New OrthoForestDMLEstimator object

SetWeightCol()

OrthoForestDMLEstimator Synapse.ML.Causal.OrthoForestDMLEstimator.SetWeightCol

(

string

value

)

Sets value for weightCol

Parameters

value

The name of the weight column

Returns

New OrthoForestDMLEstimator object

---

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

• synapse/ml/causal/OrthoForestDMLEstimator.cs