sparkocr.transformers.image_to_text#

Classes#

class ImageToText#

Bases: pyspark.ml.wrapper.JavaTransformer, pyspark.ml.param.shared.HasInputCol, pyspark.ml.param.shared.HasOutputCol, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, sparkocr.transformers.params.HasOcr

OCR based on tesseract

confidenceCol#

confidenceThreshold#

downloadModelData#

ignoreResolution#

includeConfidence#

inputCol :Param[str]#

keepLayout#

language#

modelData#

modelType#

ocrEngineMode#

ocrParams#

outputCol :Param[str]#

outputSpaceCharacterWidth#

pageIteratorLevel#

pageSegMode#

pdfCoordinates#

positionsCol#

uid = ''#

useTess4j#

withSpaces#

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.

getOutputCol() → str#

Gets the value of outputCol or its default value.

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.

classmethod load(path: str) → RL#

Reads an ML instance from the input path, a shortcut of read().load(path).

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.

setConfidenceCol(value)#

Sets the value of confidenceCol.

setConfidenceThreshold(value)#

Sets the value of confidenceThreshold.

setDownloadModelData(value)#

Sets the value of downloadModelData.

setIgnoreResolution(value)#

Sets the value of ignoreResolution.

setIncludeConfidence(value)#

Sets the value of includeConfidence.

setInputCol(value)#

Sets the value of inputCol.

setKeepLayout(value)#

Sets the value of keepLayout.

setLanguage(value)#

Sets the value of language.

setModelData(value)#

Sets the value of modelData.

setModelType(value)#

Sets the value of modelData.

setOcrEngineMode(value)#

Sets the value of ocrEngineMode.

setOcrParams(value)#

Sets the value of ocrParams.

setOutputCol(value)#

Sets the value of outputCol.

setOutputSpaceCharacterWidth(value)#

Sets the value of outputSpaceCharacterWidth.

setPageIteratorLevel(value)#

Sets the value of pageIteratorLevel.

setPageSegMode(value)#

Sets the value of pageSegMode.

setPdfCoordinates(value)#

Sets the value of pdfCoordinates.

setPositionsCol(value)#

Sets the value of positionsCol.

setUseTess4j(value)#

Sets the value of useTess4j.

setWithSpaces(value)#

Sets the value of withSpaces.

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.