Synapse.ML.Featurize.Text.PageSplitter Class Reference

PageSplitter implements PageSplitter More...

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

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

Public Member Functions
	PageSplitter ()
	Creates a PageSplitter without any parameters. More...
	PageSplitter (string uid)
	Creates a PageSplitter with a UID that is used to give the PageSplitter a unique ID. More...
PageSplitter	SetBoundaryRegex (string value)
	Sets value for boundaryRegex More...
PageSplitter	SetInputCol (string value)
	Sets value for inputCol More...
PageSplitter	SetMaximumPageLength (int value)
	Sets value for maximumPageLength More...
PageSplitter	SetMinimumPageLength (int value)
	Sets value for minimumPageLength More...
PageSplitter	SetOutputCol (string value)
	Sets value for outputCol More...
string	GetBoundaryRegex ()
	Gets boundaryRegex value More...
string	GetInputCol ()
	Gets inputCol value More...
int	GetMaximumPageLength ()
	Gets maximumPageLength value More...
int	GetMinimumPageLength ()
	Gets minimumPageLength 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< PageSplitter >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

PageSplitter implements PageSplitter

Constructor & Destructor Documentation

PageSplitter() [1/2]

Synapse.ML.Featurize.Text.PageSplitter.PageSplitter ( )

inline

Creates a PageSplitter without any parameters.

PageSplitter() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetBoundaryRegex()

string Synapse.ML.Featurize.Text.PageSplitter.GetBoundaryRegex

(

)

Gets boundaryRegex value

Returns

boundaryRegex: how to split into words

GetInputCol()

string Synapse.ML.Featurize.Text.PageSplitter.GetInputCol

(

)

Gets inputCol value

Returns

inputCol: The name of the input column

GetMaximumPageLength()

int Synapse.ML.Featurize.Text.PageSplitter.GetMaximumPageLength

(

)

Gets maximumPageLength value

Returns

maximumPageLength: the maximum number of characters to be in a page

GetMinimumPageLength()

int Synapse.ML.Featurize.Text.PageSplitter.GetMinimumPageLength

(

)

Gets minimumPageLength value

Returns

minimumPageLength: the the minimum number of characters to have on a page in order to preserve work boundaries

GetOutputCol()

string Synapse.ML.Featurize.Text.PageSplitter.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

Load()

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

static

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

Parameters

path	The path the previous PageSplitter was saved to

Returns

New PageSplitter object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<PageSplitter> instance for this ML instance.

Save()

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

SetBoundaryRegex()

PageSplitter Synapse.ML.Featurize.Text.PageSplitter.SetBoundaryRegex

(

string

value

)

Sets value for boundaryRegex

Parameters

value

how to split into words

Returns

New PageSplitter object

SetInputCol()

PageSplitter Synapse.ML.Featurize.Text.PageSplitter.SetInputCol

(

string

value

)

Sets value for inputCol

Parameters

value

The name of the input column

Returns

New PageSplitter object

SetMaximumPageLength()

PageSplitter Synapse.ML.Featurize.Text.PageSplitter.SetMaximumPageLength

(

int

value

)

Sets value for maximumPageLength

Parameters

value

the maximum number of characters to be in a page

Returns

New PageSplitter object

SetMinimumPageLength()

PageSplitter Synapse.ML.Featurize.Text.PageSplitter.SetMinimumPageLength

(

int

value

)

Sets value for minimumPageLength

Parameters

value

the the minimum number of characters to have on a page in order to preserve work boundaries

Returns

New PageSplitter object

SetOutputCol()

PageSplitter Synapse.ML.Featurize.Text.PageSplitter.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New PageSplitter object

---

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

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