DeIdentification

Instance Constructors

new DeIdentification()
new DeIdentification(uid: String)

uid
a unique identifier for the instanced Annotator

Type Members

type AnnotatorType = String

Definition Classes
HasOutputAnnotatorType

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): DeIdentificationModel

Attributes
protected
Definition Classes
AnnotatorApproach
final def asInstanceOf[T0]: T0

Definition Classes
Any
def beforeTraining(spark: SparkSession): Unit

Definition Classes
AnnotatorApproach
final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

Attributes
protected
Definition Classes
HasInputAnnotationCols
final def clear(param: Param[_]): DeIdentification.this.type

Definition Classes
Params
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def copy(extra: ParamMap): Estimator[DeIdentificationModel]

Definition Classes
AnnotatorApproach → Estimator → PipelineStage → Params
def copyValues[T <: Params](to: T, extra: ParamMap): T

Attributes
protected
Definition Classes
Params
val dateTag: Param[String]

Tag representing dates in the obfuscate reference file (default: DATE)
val dateToYear: Param[String]

'Y' if dates must be converted to years, 'N' otherwise
val days: Param[String]

Number of days to obfuscate by displacement the dates
final def defaultCopy[T <: Params](extra: ParamMap): T

Attributes
protected
Definition Classes
Params
val description: String

Definition Classes
DeIdentification → AnnotatorApproach
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
final def extractParamMap(): ParamMap

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Definition Classes
Params
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def fit(dataset: Dataset[_]): DeIdentificationModel

Definition Classes
AnnotatorApproach → Estimator
def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[DeIdentificationModel]

Definition Classes
Estimator
Annotations
@Since( "2.0.0" )
def fit(dataset: Dataset[_], paramMap: ParamMap): DeIdentificationModel

Definition Classes
Estimator
Annotations
@Since( "2.0.0" )
def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DeIdentificationModel

Definition Classes
Estimator
Annotations
@Since( "2.0.0" ) @varargs()
final def get[T](param: Param[T]): Option[T]

Definition Classes
Params
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getDefault[T](param: Param[T]): Option[T]

Definition Classes
Params
def getInputCols: Array[String]

Definition Classes
HasInputAnnotationCols
def getLazyAnnotator: Boolean

Definition Classes
CanBeLazy
final def getOrDefault[T](param: Param[T]): T

Definition Classes
Params
final def getOutputCol: String

Definition Classes
HasOutputAnnotationCol
def getParam(paramName: String): Param[Any]

Definition Classes
Params
final def hasDefault[T](param: Param[T]): Boolean

Definition Classes
Params
def hasParam(paramName: String): Boolean

Definition Classes
Params
def hashCode(): Int

Definition Classes
AnyRef → Any
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit

Attributes
protected
Definition Classes
Logging
val inputAnnotatorTypes: Array[AnnotatorType]

Definition Classes
DeIdentification → HasInputAnnotationCols
final val inputCols: StringArrayParam

Attributes
protected
Definition Classes
HasInputAnnotationCols
final def isDefined(param: Param[_]): Boolean

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isSet(param: Param[_]): Boolean

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
val lazyAnnotator: BooleanParam

Definition Classes
CanBeLazy
def log: Logger

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logName: String

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
val minYear: Param[String]

Minimum year to use when converting date to year
val mode: Param[String]

Mode for Anonymizer ['mask'|'ofuscate']
def msgHelper(schema: StructType): String

Attributes
protected
Definition Classes
HasInputAnnotationCols
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val obfuscateRefFile: Param[String]

File with the terms to be used for Obfuscation
def onTrained(model: DeIdentificationModel, spark: SparkSession): Unit

Definition Classes
AnnotatorApproach
val outputAnnotatorType: AnnotatorType

Definition Classes
DeIdentification → HasOutputAnnotatorType
final val outputCol: Param[String]

Attributes
protected
Definition Classes
HasOutputAnnotationCol
lazy val params: Array[Param[_]]

Definition Classes
Params
val refFileFormat: Param[String]

Format of the reference file for Obfuscation
val refSep: Param[String]

Separator character for the csv reference file for Obfuscation
val regexPatternsDictionary: ExternalResourceParam

dictionary with regular expression patterns that match some protected entity
def save(path: String): Unit

Definition Classes
MLWritable
Annotations
@Since( "1.6.0" ) @throws( ... )
final def set(paramPair: ParamPair[_]): DeIdentification.this.type

Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): DeIdentification.this.type

Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): DeIdentification.this.type

Definition Classes
Params
def setDateTag(s: String): DeIdentification.this.type
def setDateToYear(s: String): DeIdentification.this.type
def setDays(k: String): DeIdentification.this.type
final def setDefault(paramPairs: ParamPair[_]*): DeIdentification.this.type

Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): DeIdentification.this.type

Attributes
protected
Definition Classes
Params
final def setInputCols(value: String*): DeIdentification.this.type

Definition Classes
HasInputAnnotationCols
final def setInputCols(value: Array[String]): DeIdentification.this.type

Definition Classes
HasInputAnnotationCols
def setLazyAnnotator(value: Boolean): DeIdentification.this.type

Definition Classes
CanBeLazy
def setMinYear(s: String): DeIdentification.this.type
def setMode(m: String): DeIdentification.this.type
def setObfuscateRefFile(f: String): DeIdentification.this.type
final def setOutputCol(value: String): DeIdentification.this.type

Definition Classes
HasOutputAnnotationCol
def setRefFileFormat(f: String): DeIdentification.this.type
def setRefSep(f: String): DeIdentification.this.type
def setRegexPatternsDictionary(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("delimiter"->" ")): DeIdentification.this.type
def setRegexPatternsDictionary(path: ExternalResource): DeIdentification.this.type
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DeIdentificationModel

Returns the DeIdentificationModel Transformer, that can be used to transform input datasets
Returns the DeIdentificationModel Transformer, that can be used to transform input datasets
The dataset provided to the fit method should have one chunk per row and contain the following columns: Document, Tokens, Chunks
This method is called inside the AnnotatorApproach's fit method
dataset
a Dataset containing ChunkTokens, ChunkEmbeddings, ClassifierLabel, ResolverLabel, [ResolverNormalized]
returns
a trained ChunkEntityResolverModel

Definition Classes
DeIdentification → AnnotatorApproach
def transformRegexPatternsDictionary(regexPatternsDictionary: Array[(String, String)]): Map[String, Array[String]]
final def transformSchema(schema: StructType): StructType

Definition Classes
AnnotatorApproach → PipelineStage
def transformSchema(schema: StructType, logging: Boolean): StructType

Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
val uid: String

a unique identifier for the instanced Annotator
a unique identifier for the instanced Annotator

Definition Classes
DeIdentification → Identifiable
def validate(schema: StructType): Boolean

Attributes
protected
Definition Classes
AnnotatorApproach
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def write: MLWriter

Definition Classes
DefaultParamsWritable → MLWritable

Related Docs: object DeIdentification | package deid

class DeIdentification extends AnnotatorApproach[DeIdentificationModel] with Licensed

Instance Constructors

new DeIdentification()

new DeIdentification(uid: String)

Type Members

type AnnotatorType = String

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def $[T](param: Param[T]): T

final def ==(arg0: Any): Boolean

def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): DeIdentificationModel

final def asInstanceOf[T0]: T0

def beforeTraining(spark: SparkSession): Unit

final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

final def clear(param: Param[_]): DeIdentification.this.type

def clone(): AnyRef

final def copy(extra: ParamMap): Estimator[DeIdentificationModel]

def copyValues[T <: Params](to: T, extra: ParamMap): T

val dateTag: Param[String]

val dateToYear: Param[String]

val days: Param[String]

final def defaultCopy[T <: Params](extra: ParamMap): T

val description: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explainParam(param: Param[_]): String

def explainParams(): String

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

def finalize(): Unit

final def fit(dataset: Dataset[_]): DeIdentificationModel

def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[DeIdentificationModel]

def fit(dataset: Dataset[_], paramMap: ParamMap): DeIdentificationModel

def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DeIdentificationModel

final def get[T](param: Param[T]): Option[T]

final def getClass(): Class[_]

final def getDefault[T](param: Param[T]): Option[T]

def getInputCols: Array[String]

def getLazyAnnotator: Boolean

final def getOrDefault[T](param: Param[T]): T

final def getOutputCol: String

def getParam(paramName: String): Param[Any]

final def hasDefault[T](param: Param[T]): Boolean

def hasParam(paramName: String): Boolean

def hashCode(): Int

def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

val inputAnnotatorTypes: Array[AnnotatorType]

final val inputCols: StringArrayParam

final def isDefined(param: Param[_]): Boolean

final def isInstanceOf[T0]: Boolean

final def isSet(param: Param[_]): Boolean

def isTraceEnabled(): Boolean

val lazyAnnotator: BooleanParam

def log: Logger

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

val minYear: Param[String]

val mode: Param[String]

def msgHelper(schema: StructType): String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val obfuscateRefFile: Param[String]

def onTrained(model: DeIdentificationModel, spark: SparkSession): Unit

val outputAnnotatorType: AnnotatorType

final val outputCol: Param[String]

lazy val params: Array[Param[_]]