DoubleMLModel implements DoubleMLModel More...

Inheritance diagram for Synapse.ML.Causal.DoubleMLModel:

[legend]

Collaboration diagram for Synapse.ML.Causal.DoubleMLModel:

[legend]

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

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

DoubleMLModel	SetConfidenceLevel (double value)
	Sets value for confidenceLevel More...

DoubleMLModel	SetFeaturesCol (string value)
	Sets value for featuresCol More...

DoubleMLModel	SetMaxIter (int value)
	Sets value for maxIter More...

DoubleMLModel	SetOutcomeCol (string value)
	Sets value for outcomeCol More...

DoubleMLModel	SetOutcomeModel< M > (JavaEstimator< M > value)
	Sets value for outcomeModel More...

DoubleMLModel	SetParallelism (int value)
	Sets value for parallelism More...

DoubleMLModel	SetRawTreatmentEffects (double[] value)
	Sets value for rawTreatmentEffects More...

DoubleMLModel	SetSampleSplitRatio (double[] value)
	Sets value for sampleSplitRatio More...

DoubleMLModel	SetTreatmentCol (string value)
	Sets value for treatmentCol More...

DoubleMLModel	SetTreatmentModel< M > (JavaEstimator< M > value)
	Sets value for treatmentModel More...

DoubleMLModel	SetWeightCol (string value)
	Sets value for weightCol More...

double	GetConfidenceLevel ()
	Gets confidenceLevel value More...

string	GetFeaturesCol ()
	Gets featuresCol value More...

int	GetMaxIter ()
	Gets maxIter value More...

string	GetOutcomeCol ()
	Gets outcomeCol value More...

IEstimator< object >	GetOutcomeModel ()
	Gets outcomeModel value More...

int	GetParallelism ()
	Gets parallelism value More...

double[]	GetRawTreatmentEffects ()
	Gets rawTreatmentEffects value More...

double[]	GetSampleSplitRatio ()
	Gets sampleSplitRatio value More...

string	GetTreatmentCol ()
	Gets treatmentCol value More...

IEstimator< object >	GetTreatmentModel ()
	Gets treatmentModel 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< DoubleMLModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

DoubleMLModel implements DoubleMLModel

Constructor & Destructor Documentation

◆ DoubleMLModel() [1/2]

Synapse.ML.Causal.DoubleMLModel.DoubleMLModel ( )

inline

Creates a DoubleMLModel without any parameters.

◆ DoubleMLModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetConfidenceLevel()

double Synapse.ML.Causal.DoubleMLModel.GetConfidenceLevel ( )

Gets confidenceLevel value

Returns: confidenceLevel: confidence level, default value is 0.975

◆ GetFeaturesCol()

string Synapse.ML.Causal.DoubleMLModel.GetFeaturesCol ( )

Gets featuresCol value

Returns: featuresCol: The name of the features column

◆ GetMaxIter()

int Synapse.ML.Causal.DoubleMLModel.GetMaxIter ( )

Gets maxIter value

Returns: maxIter: maximum number of iterations (>= 0)

◆ GetOutcomeCol()

string Synapse.ML.Causal.DoubleMLModel.GetOutcomeCol ( )

Gets outcomeCol value

Returns: outcomeCol: outcome column

◆ GetOutcomeModel()

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

inline

Gets outcomeModel value

Returns: outcomeModel: outcome model to run

◆ GetParallelism()

int Synapse.ML.Causal.DoubleMLModel.GetParallelism ( )

Gets parallelism value

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

◆ GetRawTreatmentEffects()

double [] Synapse.ML.Causal.DoubleMLModel.GetRawTreatmentEffects ( )

Gets rawTreatmentEffects value

Returns: rawTreatmentEffects: raw treatment effect results for all iterations

◆ GetSampleSplitRatio()

double [] Synapse.ML.Causal.DoubleMLModel.GetSampleSplitRatio ( )

Gets sampleSplitRatio value

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

◆ GetTreatmentCol()

string Synapse.ML.Causal.DoubleMLModel.GetTreatmentCol ( )

Gets treatmentCol value

Returns: treatmentCol: treatment column

◆ GetTreatmentModel()

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

inline

Gets treatmentModel value

Returns: treatmentModel: treatment model to run

◆ GetWeightCol()

string Synapse.ML.Causal.DoubleMLModel.GetWeightCol ( )

Gets weightCol value

Returns: weightCol: The name of the weight column

◆ Load()

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

static

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

Parameters

path	The path the previous DoubleMLModel was saved to

Returns: New DoubleMLModel object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetConfidenceLevel ( double value )

Sets value for confidenceLevel

Parameters

value confidence level, default value is 0.975

Returns: New DoubleMLModel object

◆ SetFeaturesCol()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetFeaturesCol ( string value )

Sets value for featuresCol

Parameters

value The name of the features column

Returns: New DoubleMLModel object

◆ SetMaxIter()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetMaxIter ( int value )

Sets value for maxIter

Parameters

value maximum number of iterations (>= 0)

Returns: New DoubleMLModel object

◆ SetOutcomeCol()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetOutcomeCol ( string value )

Sets value for outcomeCol

Parameters

value outcome column

Returns: New DoubleMLModel object

◆ SetOutcomeModel< M >()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetOutcomeModel< M > ( JavaEstimator< M > value )

Sets value for outcomeModel

Parameters

value outcome model to run

Returns: New DoubleMLModel object

Type Constraints

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

◆ SetParallelism()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetParallelism ( int value )

Sets value for parallelism

Parameters

value the number of threads to use when running parallel algorithms

Returns: New DoubleMLModel object

◆ SetRawTreatmentEffects()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetRawTreatmentEffects ( double[] value )

Sets value for rawTreatmentEffects

Parameters

value raw treatment effect results for all iterations

Returns: New DoubleMLModel object

◆ SetSampleSplitRatio()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetSampleSplitRatio ( double[] value )

Sets value for sampleSplitRatio

Parameters

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

Returns: New DoubleMLModel object

◆ SetTreatmentCol()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetTreatmentCol ( string value )

Sets value for treatmentCol

Parameters

value treatment column

Returns: New DoubleMLModel object

◆ SetTreatmentModel< M >()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetTreatmentModel< M > ( JavaEstimator< M > value )

Sets value for treatmentModel

Parameters

value treatment model to run

Returns: New DoubleMLModel object

Type Constraints

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

◆ SetWeightCol()

DoubleMLModel Synapse.ML.Causal.DoubleMLModel.SetWeightCol ( string value )

Sets value for weightCol

Parameters

value The name of the weight column

Returns: New DoubleMLModel object

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

synapse/ml/causal/DoubleMLModel.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DoubleMLModel() [1/2]

◆ DoubleMLModel() [2/2]

Member Function Documentation

◆ GetConfidenceLevel()

◆ GetFeaturesCol()

◆ GetMaxIter()

◆ GetOutcomeCol()

◆ GetOutcomeModel()

◆ GetParallelism()

◆ GetRawTreatmentEffects()

◆ GetSampleSplitRatio()

◆ GetTreatmentCol()

◆ GetTreatmentModel()

◆ GetWeightCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetConfidenceLevel()

◆ SetFeaturesCol()

◆ SetMaxIter()

◆ SetOutcomeCol()

◆ SetOutcomeModel< M >()

◆ SetParallelism()

◆ SetRawTreatmentEffects()

◆ SetSampleSplitRatio()

◆ SetTreatmentCol()

◆ SetTreatmentModel< M >()

◆ SetWeightCol()