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

DiffInDiffEstimator implements DiffInDiffEstimator More...

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

Public Member Functions

 DiffInDiffEstimator ()
 Creates a DiffInDiffEstimator without any parameters. More...
 
 DiffInDiffEstimator (string uid)
 Creates a DiffInDiffEstimator with a UID that is used to give the DiffInDiffEstimator a unique ID. More...
 
DiffInDiffEstimator SetOutcomeCol (string value)
 Sets value for outcomeCol More...
 
DiffInDiffEstimator SetPostTreatmentCol (string value)
 Sets value for postTreatmentCol More...
 
DiffInDiffEstimator SetTreatmentCol (string value)
 Sets value for treatmentCol More...
 
string GetOutcomeCol ()
 Gets outcomeCol value More...
 
string GetPostTreatmentCol ()
 Gets postTreatmentCol value More...
 
string GetTreatmentCol ()
 Gets treatmentCol value More...
 
override DiffInDiffModel 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< DiffInDiffEstimatorRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

DiffInDiffEstimator implements DiffInDiffEstimator

Constructor & Destructor Documentation

◆ DiffInDiffEstimator() [1/2]

Synapse.ML.Causal.DiffInDiffEstimator.DiffInDiffEstimator ( )
inline

Creates a DiffInDiffEstimator without any parameters.

◆ DiffInDiffEstimator() [2/2]

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

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

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

Member Function Documentation

◆ Fit()

override DiffInDiffModel Synapse.ML.Causal.DiffInDiffEstimator.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
DiffInDiffModel

◆ GetOutcomeCol()

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

Gets outcomeCol value

Returns
outcomeCol: outcome column

◆ GetPostTreatmentCol()

string Synapse.ML.Causal.DiffInDiffEstimator.GetPostTreatmentCol ( )

Gets postTreatmentCol value

Returns
postTreatmentCol: post treatment indicator column

◆ GetTreatmentCol()

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

Gets treatmentCol value

Returns
treatmentCol: treatment column

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetOutcomeCol()

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

Sets value for outcomeCol

Parameters
valueoutcome column
Returns
New DiffInDiffEstimator object

◆ SetPostTreatmentCol()

DiffInDiffEstimator Synapse.ML.Causal.DiffInDiffEstimator.SetPostTreatmentCol ( string  value)

Sets value for postTreatmentCol

Parameters
valuepost treatment indicator column
Returns
New DiffInDiffEstimator object

◆ SetTreatmentCol()

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

Sets value for treatmentCol

Parameters
valuetreatment column
Returns
New DiffInDiffEstimator object

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