Synapseml  1.0.3
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Vw.VowpalWabbitInteractions Class Reference

VowpalWabbitInteractions implements VowpalWabbitInteractions More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitInteractions:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Vw.VowpalWabbitInteractions:
Collaboration graph
[legend]

Public Member Functions

 VowpalWabbitInteractions ()
 Creates a VowpalWabbitInteractions without any parameters. More...
 
 VowpalWabbitInteractions (string uid)
 Creates a VowpalWabbitInteractions with a UID that is used to give the VowpalWabbitInteractions a unique ID. More...
 
VowpalWabbitInteractions SetInputCols (string[] value)
 Sets value for inputCols More...
 
VowpalWabbitInteractions SetNumBits (int value)
 Sets value for numBits More...
 
VowpalWabbitInteractions SetOutputCol (string value)
 Sets value for outputCol More...
 
VowpalWabbitInteractions SetSumCollisions (bool value)
 Sets value for sumCollisions More...
 
string[] GetInputCols ()
 Gets inputCols value More...
 
int GetNumBits ()
 Gets numBits value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
bool GetSumCollisions ()
 Gets sumCollisions 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< VowpalWabbitInteractionsRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

VowpalWabbitInteractions implements VowpalWabbitInteractions

Constructor & Destructor Documentation

◆ VowpalWabbitInteractions() [1/2]

Synapse.ML.Vw.VowpalWabbitInteractions.VowpalWabbitInteractions ( )
inline

Creates a VowpalWabbitInteractions without any parameters.

◆ VowpalWabbitInteractions() [2/2]

Synapse.ML.Vw.VowpalWabbitInteractions.VowpalWabbitInteractions ( string  uid)
inline

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

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

Member Function Documentation

◆ GetInputCols()

string [] Synapse.ML.Vw.VowpalWabbitInteractions.GetInputCols ( )

Gets inputCols value

Returns
inputCols: The names of the input columns

◆ GetNumBits()

int Synapse.ML.Vw.VowpalWabbitInteractions.GetNumBits ( )

Gets numBits value

Returns
numBits: Number of bits used to mask

◆ GetOutputCol()

string Synapse.ML.Vw.VowpalWabbitInteractions.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSumCollisions()

bool Synapse.ML.Vw.VowpalWabbitInteractions.GetSumCollisions ( )

Gets sumCollisions value

Returns
sumCollisions: Sums collisions if true, otherwise removes them

◆ Load()

static VowpalWabbitInteractions Synapse.ML.Vw.VowpalWabbitInteractions.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<VowpalWabbitInteractions> Synapse.ML.Vw.VowpalWabbitInteractions.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Vw.VowpalWabbitInteractions.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

◆ SetInputCols()

VowpalWabbitInteractions Synapse.ML.Vw.VowpalWabbitInteractions.SetInputCols ( string[]  value)

Sets value for inputCols

Parameters
valueThe names of the input columns
Returns
New VowpalWabbitInteractions object

◆ SetNumBits()

VowpalWabbitInteractions Synapse.ML.Vw.VowpalWabbitInteractions.SetNumBits ( int  value)

Sets value for numBits

Parameters
valueNumber of bits used to mask
Returns
New VowpalWabbitInteractions object

◆ SetOutputCol()

VowpalWabbitInteractions Synapse.ML.Vw.VowpalWabbitInteractions.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New VowpalWabbitInteractions object

◆ SetSumCollisions()

VowpalWabbitInteractions Synapse.ML.Vw.VowpalWabbitInteractions.SetSumCollisions ( bool  value)

Sets value for sumCollisions

Parameters
valueSums collisions if true, otherwise removes them
Returns
New VowpalWabbitInteractions object

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