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

VowpalWabbitDSJsonTransformer implements VowpalWabbitDSJsonTransformer More...

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

Public Member Functions

 VowpalWabbitDSJsonTransformer ()
 Creates a VowpalWabbitDSJsonTransformer without any parameters. More...
 
 VowpalWabbitDSJsonTransformer (string uid)
 Creates a VowpalWabbitDSJsonTransformer with a UID that is used to give the VowpalWabbitDSJsonTransformer a unique ID. More...
 
VowpalWabbitDSJsonTransformer SetDsJsonColumn (string value)
 Sets value for dsJsonColumn More...
 
VowpalWabbitDSJsonTransformer SetRewards (Dictionary< string, string > value)
 Sets value for rewards More...
 
string GetDsJsonColumn ()
 Gets dsJsonColumn value More...
 
Dictionary< string, string > GetRewards ()
 Gets rewards 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< VowpalWabbitDSJsonTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

VowpalWabbitDSJsonTransformer implements VowpalWabbitDSJsonTransformer

Constructor & Destructor Documentation

◆ VowpalWabbitDSJsonTransformer() [1/2]

Synapse.ML.Vw.VowpalWabbitDSJsonTransformer.VowpalWabbitDSJsonTransformer ( )
inline

Creates a VowpalWabbitDSJsonTransformer without any parameters.

◆ VowpalWabbitDSJsonTransformer() [2/2]

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

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

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

Member Function Documentation

◆ GetDsJsonColumn()

string Synapse.ML.Vw.VowpalWabbitDSJsonTransformer.GetDsJsonColumn ( )

Gets dsJsonColumn value

Returns
dsJsonColumn: Column containing ds-json. defaults to "value".

◆ GetRewards()

Dictionary<string, string> Synapse.ML.Vw.VowpalWabbitDSJsonTransformer.GetRewards ( )
inline

Gets rewards value

Returns
rewards: Extract bandit reward(s) from DS json. Defaults to _label_cost.

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetDsJsonColumn()

VowpalWabbitDSJsonTransformer Synapse.ML.Vw.VowpalWabbitDSJsonTransformer.SetDsJsonColumn ( string  value)

Sets value for dsJsonColumn

Parameters
valueColumn containing ds-json. defaults to "value".
Returns
New VowpalWabbitDSJsonTransformer object

◆ SetRewards()

VowpalWabbitDSJsonTransformer Synapse.ML.Vw.VowpalWabbitDSJsonTransformer.SetRewards ( Dictionary< string, string >  value)

Sets value for rewards

Parameters
valueExtract bandit reward(s) from DS json. Defaults to _label_cost.
Returns
New VowpalWabbitDSJsonTransformer object

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