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

SummarizeData implements SummarizeData More...

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

Public Member Functions

 SummarizeData ()
 Creates a SummarizeData without any parameters. More...
 
 SummarizeData (string uid)
 Creates a SummarizeData with a UID that is used to give the SummarizeData a unique ID. More...
 
SummarizeData SetBasic (bool value)
 Sets value for basic More...
 
SummarizeData SetCounts (bool value)
 Sets value for counts More...
 
SummarizeData SetErrorThreshold (double value)
 Sets value for errorThreshold More...
 
SummarizeData SetPercentiles (bool value)
 Sets value for percentiles More...
 
SummarizeData SetSample (bool value)
 Sets value for sample More...
 
bool GetBasic ()
 Gets basic value More...
 
bool GetCounts ()
 Gets counts value More...
 
double GetErrorThreshold ()
 Gets errorThreshold value More...
 
bool GetPercentiles ()
 Gets percentiles value More...
 
bool GetSample ()
 Gets sample 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< SummarizeDataRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

SummarizeData implements SummarizeData

Constructor & Destructor Documentation

◆ SummarizeData() [1/2]

Synapse.ML.Stages.SummarizeData.SummarizeData ( )
inline

Creates a SummarizeData without any parameters.

◆ SummarizeData() [2/2]

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

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

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

Member Function Documentation

◆ GetBasic()

bool Synapse.ML.Stages.SummarizeData.GetBasic ( )

Gets basic value

Returns
basic: Compute basic statistics

◆ GetCounts()

bool Synapse.ML.Stages.SummarizeData.GetCounts ( )

Gets counts value

Returns
counts: Compute count statistics

◆ GetErrorThreshold()

double Synapse.ML.Stages.SummarizeData.GetErrorThreshold ( )

Gets errorThreshold value

Returns
errorThreshold: Threshold for quantiles - 0 is exact

◆ GetPercentiles()

bool Synapse.ML.Stages.SummarizeData.GetPercentiles ( )

Gets percentiles value

Returns
percentiles: Compute percentiles

◆ GetSample()

bool Synapse.ML.Stages.SummarizeData.GetSample ( )

Gets sample value

Returns
sample: Compute sample statistics

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetBasic()

SummarizeData Synapse.ML.Stages.SummarizeData.SetBasic ( bool  value)

Sets value for basic

Parameters
valueCompute basic statistics
Returns
New SummarizeData object

◆ SetCounts()

SummarizeData Synapse.ML.Stages.SummarizeData.SetCounts ( bool  value)

Sets value for counts

Parameters
valueCompute count statistics
Returns
New SummarizeData object

◆ SetErrorThreshold()

SummarizeData Synapse.ML.Stages.SummarizeData.SetErrorThreshold ( double  value)

Sets value for errorThreshold

Parameters
valueThreshold for quantiles - 0 is exact
Returns
New SummarizeData object

◆ SetPercentiles()

SummarizeData Synapse.ML.Stages.SummarizeData.SetPercentiles ( bool  value)

Sets value for percentiles

Parameters
valueCompute percentiles
Returns
New SummarizeData object

◆ SetSample()

SummarizeData Synapse.ML.Stages.SummarizeData.SetSample ( bool  value)

Sets value for sample

Parameters
valueCompute sample statistics
Returns
New SummarizeData object

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