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

FixedMiniBatchTransformer implements FixedMiniBatchTransformer More...

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

Public Member Functions

 FixedMiniBatchTransformer ()
 Creates a FixedMiniBatchTransformer without any parameters. More...
 
 FixedMiniBatchTransformer (string uid)
 Creates a FixedMiniBatchTransformer with a UID that is used to give the FixedMiniBatchTransformer a unique ID. More...
 
FixedMiniBatchTransformer SetBatchSize (int value)
 Sets value for batchSize More...
 
FixedMiniBatchTransformer SetBuffered (bool value)
 Sets value for buffered More...
 
FixedMiniBatchTransformer SetMaxBufferSize (int value)
 Sets value for maxBufferSize More...
 
int GetBatchSize ()
 Gets batchSize value More...
 
bool GetBuffered ()
 Gets buffered value More...
 
int GetMaxBufferSize ()
 Gets maxBufferSize 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< FixedMiniBatchTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

FixedMiniBatchTransformer implements FixedMiniBatchTransformer

Constructor & Destructor Documentation

◆ FixedMiniBatchTransformer() [1/2]

Synapse.ML.Stages.FixedMiniBatchTransformer.FixedMiniBatchTransformer ( )
inline

Creates a FixedMiniBatchTransformer without any parameters.

◆ FixedMiniBatchTransformer() [2/2]

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

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

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

Member Function Documentation

◆ GetBatchSize()

int Synapse.ML.Stages.FixedMiniBatchTransformer.GetBatchSize ( )

Gets batchSize value

Returns
batchSize: The max size of the buffer

◆ GetBuffered()

bool Synapse.ML.Stages.FixedMiniBatchTransformer.GetBuffered ( )

Gets buffered value

Returns
buffered: Whether or not to buffer batches in memory

◆ GetMaxBufferSize()

int Synapse.ML.Stages.FixedMiniBatchTransformer.GetMaxBufferSize ( )

Gets maxBufferSize value

Returns
maxBufferSize: The max size of the buffer

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetBatchSize()

FixedMiniBatchTransformer Synapse.ML.Stages.FixedMiniBatchTransformer.SetBatchSize ( int  value)

Sets value for batchSize

Parameters
valueThe max size of the buffer
Returns
New FixedMiniBatchTransformer object

◆ SetBuffered()

FixedMiniBatchTransformer Synapse.ML.Stages.FixedMiniBatchTransformer.SetBuffered ( bool  value)

Sets value for buffered

Parameters
valueWhether or not to buffer batches in memory
Returns
New FixedMiniBatchTransformer object

◆ SetMaxBufferSize()

FixedMiniBatchTransformer Synapse.ML.Stages.FixedMiniBatchTransformer.SetMaxBufferSize ( int  value)

Sets value for maxBufferSize

Parameters
valueThe max size of the buffer
Returns
New FixedMiniBatchTransformer object

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