Synapse.ML.Stages.TimerModel Class Reference

TimerModel implements TimerModel More...

Inheritance diagram for Synapse.ML.Stages.TimerModel:

Collaboration diagram for Synapse.ML.Stages.TimerModel:

Public Member Functions
	TimerModel ()
	Creates a TimerModel without any parameters. More...
	TimerModel (string uid)
	Creates a TimerModel with a UID that is used to give the TimerModel a unique ID. More...
TimerModel	SetDisableMaterialization (bool value)
	Sets value for disableMaterialization More...
TimerModel	SetLogToScala (bool value)
	Sets value for logToScala More...
TimerModel	SetStage (JavaPipelineStage value)
	Sets value for stage More...
TimerModel	SetTransformer (JavaTransformer value)
	Sets value for transformer More...
bool	GetDisableMaterialization ()
	Gets disableMaterialization value More...
bool	GetLogToScala ()
	Gets logToScala value More...
JavaPipelineStage	GetStage ()
	Gets stage value More...
JavaTransformer	GetTransformer ()
	Gets transformer 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< TimerModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

TimerModel implements TimerModel

Constructor & Destructor Documentation

TimerModel() [1/2]

Synapse.ML.Stages.TimerModel.TimerModel ( )

inline

Creates a TimerModel without any parameters.

TimerModel() [2/2]

Synapse.ML.Stages.TimerModel.TimerModel ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetDisableMaterialization()

bool Synapse.ML.Stages.TimerModel.GetDisableMaterialization

(

)

Gets disableMaterialization value

Returns

disableMaterialization: Whether to disable timing (so that one can turn it off for evaluation)

GetLogToScala()

bool Synapse.ML.Stages.TimerModel.GetLogToScala

(

)

Gets logToScala value

Returns

logToScala: Whether to output the time to the scala console

GetStage()

JavaPipelineStage Synapse.ML.Stages.TimerModel.GetStage ( )

inline

Gets stage value

Returns

stage: The stage to time

GetTransformer()

JavaTransformer Synapse.ML.Stages.TimerModel.GetTransformer ( )

inline

Gets transformer value

Returns

transformer: inner model to time

Load()

static TimerModel Synapse.ML.Stages.TimerModel.Load ( string  path )

static

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

Parameters

path	The path the previous TimerModel was saved to

Returns

New TimerModel object, loaded from path.

Read()

JavaMLReader<TimerModel> Synapse.ML.Stages.TimerModel.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<TimerModel> instance for this ML instance.

Save()

void Synapse.ML.Stages.TimerModel.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

SetDisableMaterialization()

TimerModel Synapse.ML.Stages.TimerModel.SetDisableMaterialization

(

bool

value

)

Sets value for disableMaterialization

Parameters

value

Whether to disable timing (so that one can turn it off for evaluation)

Returns

New TimerModel object

SetLogToScala()

TimerModel Synapse.ML.Stages.TimerModel.SetLogToScala

(

bool

value

)

Sets value for logToScala

Parameters

value

Whether to output the time to the scala console

Returns

New TimerModel object

SetStage()

TimerModel Synapse.ML.Stages.TimerModel.SetStage

(

JavaPipelineStage

value

)

Sets value for stage

Parameters

value

The stage to time

Returns

New TimerModel object

SetTransformer()

TimerModel Synapse.ML.Stages.TimerModel.SetTransformer

(

JavaTransformer

value

)

Sets value for transformer

Parameters

value

inner model to time

Returns

New TimerModel object

---

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

• synapse/ml/stages/TimerModel.cs