Synapse.ML.Causal.DiffInDiffModel Class Reference

DiffInDiffModel implements DiffInDiffModel More...

Inheritance diagram for Synapse.ML.Causal.DiffInDiffModel:

Collaboration diagram for Synapse.ML.Causal.DiffInDiffModel:

Public Member Functions
	DiffInDiffModel ()
	Creates a DiffInDiffModel without any parameters. More...
	DiffInDiffModel (string uid)
	Creates a DiffInDiffModel with a UID that is used to give the DiffInDiffModel a unique ID. More...
DiffInDiffModel	SetTimeCol (string value)
	Sets value for timeCol More...
DiffInDiffModel	SetTimeIndex (DataFrame value)
	Sets value for timeIndex More...
DiffInDiffModel	SetTimeIndexCol (string value)
	Sets value for timeIndexCol More...
DiffInDiffModel	SetUnitCol (string value)
	Sets value for unitCol More...
DiffInDiffModel	SetUnitIndex (DataFrame value)
	Sets value for unitIndex More...
DiffInDiffModel	SetUnitIndexCol (string value)
	Sets value for unitIndexCol More...
string	GetTimeCol ()
	Gets timeCol value More...
DataFrame	GetTimeIndex ()
	Gets timeIndex value More...
string	GetTimeIndexCol ()
	Gets timeIndexCol value More...
string	GetUnitCol ()
	Gets unitCol value More...
DataFrame	GetUnitIndex ()
	Gets unitIndex value More...
string	GetUnitIndexCol ()
	Gets unitIndexCol 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< DiffInDiffModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

DiffInDiffModel implements DiffInDiffModel

Constructor & Destructor Documentation

DiffInDiffModel() [1/2]

Synapse.ML.Causal.DiffInDiffModel.DiffInDiffModel ( )

inline

Creates a DiffInDiffModel without any parameters.

DiffInDiffModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetTimeCol()

string Synapse.ML.Causal.DiffInDiffModel.GetTimeCol

(

)

Gets timeCol value

Returns

timeCol: Specify the column that identifies the time when outcome is measured in the panel data. For example, if the outcome is measured daily, this column could be the Date column.

GetTimeIndex()

DataFrame Synapse.ML.Causal.DiffInDiffModel.GetTimeIndex

(

)

Gets timeIndex value

Returns

timeIndex: time index

GetTimeIndexCol()

string Synapse.ML.Causal.DiffInDiffModel.GetTimeIndexCol

(

)

Gets timeIndexCol value

Returns

timeIndexCol: time index column

GetUnitCol()

string Synapse.ML.Causal.DiffInDiffModel.GetUnitCol

(

)

Gets unitCol value

Returns

unitCol: Specify the name of the column which contains an identifier for each observed unit in the panel data. For example, if the observed units are users, this column could be the UserId column.

GetUnitIndex()

DataFrame Synapse.ML.Causal.DiffInDiffModel.GetUnitIndex

(

)

Gets unitIndex value

Returns

unitIndex: unit index

GetUnitIndexCol()

string Synapse.ML.Causal.DiffInDiffModel.GetUnitIndexCol

(

)

Gets unitIndexCol value

Returns

unitIndexCol: unit index column

Load()

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

static

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

Parameters

path	The path the previous DiffInDiffModel was saved to

Returns

New DiffInDiffModel object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<DiffInDiffModel> instance for this ML instance.

Save()

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

SetTimeCol()

DiffInDiffModel Synapse.ML.Causal.DiffInDiffModel.SetTimeCol

(

string

value

)

Sets value for timeCol

Parameters

value

Specify the column that identifies the time when outcome is measured in the panel data. For example, if the outcome is measured daily, this column could be the Date column.

Returns

New DiffInDiffModel object

SetTimeIndex()

DiffInDiffModel Synapse.ML.Causal.DiffInDiffModel.SetTimeIndex

(

DataFrame

value

)

Sets value for timeIndex

Parameters

value

time index

Returns

New DiffInDiffModel object

SetTimeIndexCol()

DiffInDiffModel Synapse.ML.Causal.DiffInDiffModel.SetTimeIndexCol

(

string

value

)

Sets value for timeIndexCol

Parameters

value

time index column

Returns

New DiffInDiffModel object

SetUnitCol()

DiffInDiffModel Synapse.ML.Causal.DiffInDiffModel.SetUnitCol

(

string

value

)

Sets value for unitCol

Parameters

value

Specify the name of the column which contains an identifier for each observed unit in the panel data. For example, if the observed units are users, this column could be the UserId column.

Returns

New DiffInDiffModel object

SetUnitIndex()

DiffInDiffModel Synapse.ML.Causal.DiffInDiffModel.SetUnitIndex

(

DataFrame

value

)

Sets value for unitIndex

Parameters

value

unit index

Returns

New DiffInDiffModel object

SetUnitIndexCol()

DiffInDiffModel Synapse.ML.Causal.DiffInDiffModel.SetUnitIndexCol

(

string

value

)

Sets value for unitIndexCol

Parameters

value

unit index column

Returns

New DiffInDiffModel object

---

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

• synapse/ml/causal/DiffInDiffModel.cs