sparknlp.annotator.NerApproach

class sparknlp.annotator.NerApproach[source]

Bases: pyspark.ml.param.Params

Base class for Ner*Approach Annotators

Methods

__init__()

clear(param)

Clears a param from the param map if it has been explicitly set.

copy([extra])

Creates a copy of this instance with the same uid and some extra params.

explainParam(param)

Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.

explainParams()

Returns the documentation of all params with their optionally default values and user-supplied values.

extractParamMap([extra])

Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra.

getLabelColumn()

Gets column for label per each token.

getOrDefault(param)

Gets the value of a param in the user-supplied param map or its default value.

getParam(paramName)

Gets a param by its name.

hasDefault(param)

Checks whether a param has a default value.

hasParam(paramName)

Tests whether this instance contains a param with a given (string) name.

isDefined(param)

Checks whether a param is explicitly set by user or has a default value.

isSet(param)

Checks whether a param is explicitly set by user.

set(param, value)

Sets a parameter in the embedded param map.

setEntities(tags)

Sets entities to recognize.

setLabelColumn(value)

Sets name of column for data labels.

setMaxEpochs(epochs)

Sets maximum number of epochs to train.

setMinEpochs(epochs)

Sets minimum number of epochs to train.

setRandomSeed(seed)

Sets random seed for shuffling.

setVerbose(verboseValue)

Sets level of verbosity during training.

Attributes

entities

labelColumn

maxEpochs

minEpochs

params

Returns all params ordered by name.

randomSeed

verbose

clear(param)

Clears a param from the param map if it has been explicitly set.

copy(extra=None)

Creates a copy of this instance with the same uid and some extra params. The default implementation creates a shallow copy using copy.copy(), and then copies the embedded and extra parameters over and returns the copy. Subclasses should override this method if the default approach is not sufficient.

Parameters

extra – Extra parameters to copy to the new instance

Returns

Copy of this instance

explainParam(param)

Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.

explainParams()

Returns the documentation of all params with their optionally default values and user-supplied values.

extractParamMap(extra=None)

Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra.

Parameters

extra – extra param values

Returns

merged param map

getLabelColumn()[source]

Gets column for label per each token.

Returns
str

Column with label per each token

getOrDefault(param)

Gets the value of a param in the user-supplied param map or its default value. Raises an error if neither is set.

getParam(paramName)

Gets a param by its name.

hasDefault(param)

Checks whether a param has a default value.

hasParam(paramName)

Tests whether this instance contains a param with a given (string) name.

isDefined(param)

Checks whether a param is explicitly set by user or has a default value.

isSet(param)

Checks whether a param is explicitly set by user.

property params

Returns all params ordered by name. The default implementation uses dir() to get all attributes of type Param.

set(param, value)

Sets a parameter in the embedded param map.

setEntities(tags)[source]

Sets entities to recognize.

Parameters
tagsList[str]

List of entities

setLabelColumn(value)[source]

Sets name of column for data labels.

Parameters
valuestr

Column for data labels

setMaxEpochs(epochs)[source]

Sets maximum number of epochs to train.

Parameters
epochsint

Maximum number of epochs to train

setMinEpochs(epochs)[source]

Sets minimum number of epochs to train.

Parameters
epochsint

Minimum number of epochs to train

setRandomSeed(seed)[source]

Sets random seed for shuffling.

Parameters
seedint

Random seed for shuffling

setVerbose(verboseValue)[source]

Sets level of verbosity during training.

Parameters
verboseValueint

Level of verbosity

uid

A unique id for the object.