Synapseml  0.11.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Stages.Timer Class Reference

Timer implements Timer More...

Inheritance diagram for Synapse.ML.Stages.Timer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Stages.Timer:
Collaboration graph
[legend]

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Timer implements Timer

Constructor & Destructor Documentation

◆ Timer() [1/2]

Synapse.ML.Stages.Timer.Timer ( )
inline

Creates a Timer without any parameters.

◆ Timer() [2/2]

Synapse.ML.Stages.Timer.Timer ( string  uid)
inline

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

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

Member Function Documentation

◆ Fit()

override TimerModel Synapse.ML.Stages.Timer.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
TimerModel

◆ GetDisableMaterialization()

bool Synapse.ML.Stages.Timer.GetDisableMaterialization ( )

Gets disableMaterialization value

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

◆ GetLogToScala()

bool Synapse.ML.Stages.Timer.GetLogToScala ( )

Gets logToScala value

Returns
logToScala: Whether to output the time to the scala console

◆ GetStage()

JavaPipelineStage Synapse.ML.Stages.Timer.GetStage ( )
inline

Gets stage value

Returns
stage: The stage to time

◆ Load()

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

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

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

◆ Read()

JavaMLReader<Timer> Synapse.ML.Stages.Timer.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetDisableMaterialization()

Timer Synapse.ML.Stages.Timer.SetDisableMaterialization ( bool  value)

Sets value for disableMaterialization

Parameters
valueWhether to disable timing (so that one can turn it off for evaluation)
Returns
New Timer object

◆ SetLogToScala()

Timer Synapse.ML.Stages.Timer.SetLogToScala ( bool  value)

Sets value for logToScala

Parameters
valueWhether to output the time to the scala console
Returns
New Timer object

◆ SetStage()

Timer Synapse.ML.Stages.Timer.SetStage ( JavaPipelineStage  value)

Sets value for stage

Parameters
valueThe stage to time
Returns
New Timer object

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