Synapse.ML.Featurize.Text.MultiNGram Class Reference

MultiNGram implements MultiNGram More...

Inheritance diagram for Synapse.ML.Featurize.Text.MultiNGram:

Collaboration diagram for Synapse.ML.Featurize.Text.MultiNGram:

Public Member Functions
	MultiNGram ()
	Creates a MultiNGram without any parameters. More...
	MultiNGram (string uid)
	Creates a MultiNGram with a UID that is used to give the MultiNGram a unique ID. More...
MultiNGram	SetInputCol (string value)
	Sets value for inputCol More...
MultiNGram	SetLengths (int[] value)
	Sets value for lengths More...
MultiNGram	SetOutputCol (string value)
	Sets value for outputCol More...
string	GetInputCol ()
	Gets inputCol value More...
int[]	GetLengths ()
	Gets lengths value More...
string	GetOutputCol ()
	Gets outputCol 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< MultiNGram >	Read ()
	Get the corresponding JavaMLReader instance. More...

Static Public Member Functions
static MultiNGram	Load (string path)
	Loads the MultiNGram that was previously saved using Save(string). More...

Detailed Description

MultiNGram implements MultiNGram

Constructor & Destructor Documentation

MultiNGram() [1/2]

Synapse.ML.Featurize.Text.MultiNGram.MultiNGram ( )

inline

Creates a MultiNGram without any parameters.

MultiNGram() [2/2]

Synapse.ML.Featurize.Text.MultiNGram.MultiNGram ( string  uid )

inline

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

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

GetInputCol()

string Synapse.ML.Featurize.Text.MultiNGram.GetInputCol

(

)

Gets inputCol value

Returns

inputCol: The name of the input column

GetLengths()

int [] Synapse.ML.Featurize.Text.MultiNGram.GetLengths ( )

inline

Gets lengths value

Returns

lengths: the collection of lengths to use for ngram extraction

GetOutputCol()

string Synapse.ML.Featurize.Text.MultiNGram.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

Load()

static MultiNGram Synapse.ML.Featurize.Text.MultiNGram.Load ( string  path )

static

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

Parameters

path	The path the previous MultiNGram was saved to

Returns

New MultiNGram object, loaded from path.

Read()

JavaMLReader<MultiNGram> Synapse.ML.Featurize.Text.MultiNGram.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<MultiNGram> instance for this ML instance.

Save()

void Synapse.ML.Featurize.Text.MultiNGram.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

path	The path to save the object to

SetInputCol()

MultiNGram Synapse.ML.Featurize.Text.MultiNGram.SetInputCol

(

string

value

)

Sets value for inputCol

Parameters

value

The name of the input column

Returns

New MultiNGram object

SetLengths()

MultiNGram Synapse.ML.Featurize.Text.MultiNGram.SetLengths

(

int[]

value

)

Sets value for lengths

Parameters

value

the collection of lengths to use for ngram extraction

Returns

New MultiNGram object

SetOutputCol()

MultiNGram Synapse.ML.Featurize.Text.MultiNGram.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New MultiNGram object

---

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

• synapse/ml/featurize/text/MultiNGram.cs