sparkocr.transformers.visual_document_classifier#

Classes#

class VisualDocumentClassifier(classname='com.johnsnowlabs.ocr.transformers.VisualDocumentClassifier', java_model=None)#

Bases: pyspark.ml.wrapper.JavaTransformer, pyspark.ml.param.shared.HasInputCol, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable

Base class for :py:class:`Transformer`s that wrap Java/Scala implementations. Subclasses should ensure they have the transformer Java object available as _java_obj.

caseSensitive#

confidenceCol#

confidenceThreshold#

inputCol :Param[str]#

labelCol#

labels#

maxSentenceLength#

name = 'VisualDocumentClassifier'#

uid = ''#

clear(param: pyspark.ml.param.Param) → None#

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

copy(extra: pyspark.ml._typing.ParamMap | None = None) → JP#

Creates a copy of this instance with the same uid and some extra params. This implementation first calls Params.copy and then make a copy of the companion Java pipeline component with extra params. So both the Python wrapper and the Java pipeline component get copied.

Parameters:

extra (dict, optional) – Extra parameters to copy to the new instance

Returns:

Copy of this instance

Return type:

JavaParams

explainParam(param: str | Param) → str#

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

explainParams() → str#

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

extractParamMap(extra: pyspark.ml._typing.ParamMap | None = None) → pyspark.ml._typing.ParamMap#

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 (dict, optional) – extra param values

Returns:

merged param map

Return type:

dict

getInputCol() → str#

Gets the value of inputCol or its default value.

getOrDefault(param: str) → Any#

getOrDefault(param: Param[T]) → T

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: str) → Param#

Gets a param by its name.

hasDefault(param: str | Param[Any]) → bool#

Checks whether a param has a default value.

hasParam(paramName: str) → bool#

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

isDefined(param: str | Param[Any]) → bool#

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

isSet(param: str | Param[Any]) → bool#

Checks whether a param is explicitly set by user.

static load(folder)#

Loads a tensorflow graph and setups model :param folder: location of tensorflow model :param spark_session: Spark session :return:

static loadTFModel(folder, spark_session)#

Loads a tensorflow graph and setups model :param folder: location of tensorflow model :param spark_session: Spark session :return:

static pretrained(name, lang='en', remote_loc=None)#

classmethod read() → JavaMLReader[RL]#

Returns an MLReader instance for this class.

save(path: str) → None#

Save this ML instance to the given path, a shortcut of ‘write().save(path)’.

set(param: Param, value: Any) → None#

Sets a parameter in the embedded param map.

setCaseSensitive(value)#

Sets the value of caseSensitive.

setConfidenceCol(value)#

Sets the value of confidenceCol.

setConfidenceThreshold(value)#

Sets the value of confidenceThreshold.

setInputCol(value)#

Sets the value of inputCol.

setLabelCol(value)#

Sets the value of labelCol.

setLabels(value)#

Sets document class labels.

setMaxSentenceLength(value)#

Sets the value of maxSentenceLength.

transform(dataset: pyspark.sql.dataframe.DataFrame, params: pyspark.ml._typing.ParamMap | None = None) → pyspark.sql.dataframe.DataFrame#

Transforms the input dataset with optional parameters.

New in version 1.3.0.

Parameters:

• dataset (pyspark.sql.DataFrame) – input dataset

• params (dict, optional) – an optional param map that overrides embedded params.

Returns:

transformed dataset

Return type:

pyspark.sql.DataFrame

write() → JavaMLWriter#

Returns an MLWriter instance for this ML instance.