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

TimeIntervalMiniBatchTransformer implements TimeIntervalMiniBatchTransformer More...

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

Public Member Functions

 TimeIntervalMiniBatchTransformer ()
 Creates a TimeIntervalMiniBatchTransformer without any parameters. More...
 
 TimeIntervalMiniBatchTransformer (string uid)
 Creates a TimeIntervalMiniBatchTransformer with a UID that is used to give the TimeIntervalMiniBatchTransformer a unique ID. More...
 
TimeIntervalMiniBatchTransformer SetMaxBatchSize (int value)
 Sets value for maxBatchSize More...
 
TimeIntervalMiniBatchTransformer SetMillisToWait (int value)
 Sets value for millisToWait More...
 
int GetMaxBatchSize ()
 Gets maxBatchSize value More...
 
int GetMillisToWait ()
 Gets millisToWait 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< TimeIntervalMiniBatchTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

TimeIntervalMiniBatchTransformer implements TimeIntervalMiniBatchTransformer

Constructor & Destructor Documentation

◆ TimeIntervalMiniBatchTransformer() [1/2]

Synapse.ML.Stages.TimeIntervalMiniBatchTransformer.TimeIntervalMiniBatchTransformer ( )
inline

Creates a TimeIntervalMiniBatchTransformer without any parameters.

◆ TimeIntervalMiniBatchTransformer() [2/2]

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

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

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

Member Function Documentation

◆ GetMaxBatchSize()

int Synapse.ML.Stages.TimeIntervalMiniBatchTransformer.GetMaxBatchSize ( )

Gets maxBatchSize value

Returns
maxBatchSize: The max size of the buffer

◆ GetMillisToWait()

int Synapse.ML.Stages.TimeIntervalMiniBatchTransformer.GetMillisToWait ( )

Gets millisToWait value

Returns
millisToWait: The time to wait before constructing a batch

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetMaxBatchSize()

TimeIntervalMiniBatchTransformer Synapse.ML.Stages.TimeIntervalMiniBatchTransformer.SetMaxBatchSize ( int  value)

Sets value for maxBatchSize

Parameters
valueThe max size of the buffer
Returns
New TimeIntervalMiniBatchTransformer object

◆ SetMillisToWait()

TimeIntervalMiniBatchTransformer Synapse.ML.Stages.TimeIntervalMiniBatchTransformer.SetMillisToWait ( int  value)

Sets value for millisToWait

Parameters
valueThe time to wait before constructing a batch
Returns
New TimeIntervalMiniBatchTransformer object

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