Class/Object

com.johnsnowlabs.nlp.annotators.deid

DeIdentificationModel

Related Docs: object DeIdentificationModel | package deid

Permalink

class DeIdentificationModel extends AnnotatorModel[DeIdentificationModel] with Licensed

Contains all the parameters to transform a dataset with three Input Annotations of types DOCUMENT, TOKEN and CHUNK, into its DeIdentified version of by either masking or obfuscating the given CHUNKS

Linear Supertypes
Licensed, AnnotatorModel[DeIdentificationModel], CanBeLazy, RawAnnotator[DeIdentificationModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[DeIdentificationModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeIdentificationModel
  2. Licensed
  3. AnnotatorModel
  4. CanBeLazy
  5. RawAnnotator
  6. HasOutputAnnotationCol
  7. HasInputAnnotationCols
  8. HasOutputAnnotatorType
  9. ParamsAndFeaturesWritable
  10. HasFeatures
  11. DefaultParamsWritable
  12. MLWritable
  13. Model
  14. Transformer
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Serializable
  20. Identifiable
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeIdentificationModel()

    Permalink
  2. new DeIdentificationModel(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType
  3. implicit class StringReplacement extends AnyRef

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. val allTerms: MapFeature[String, List[String]]

    Permalink
  12. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink
    Definition Classes
    DeIdentificationModel → AnnotatorModel
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

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

    Permalink
    Definition Classes
    Params
  17. def clone(): AnyRef

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

    Permalink
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  20. def createAnonymizeAnnotation(anonymizeSentence: String, idx: Int): Annotation

    Permalink
  21. val dateTag: Param[String]

    Permalink
  22. val dateToYear: Param[String]

    Permalink
  23. val days: Param[String]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  25. def dfAnnotate: UserDefinedFunction

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  26. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Params
  29. def explainParams(): String

    Permalink
    Definition Classes
    Params
  30. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. def extraValidateMsg: String

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  33. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  34. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  41. def getAnonymizeSentence(sentence: String, protectedEntities: Seq[Annotation], dateTag: String = "", days: String = "0", dateToYear: String = "N", minYear: String = "1929"): String

    Permalink
  42. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  44. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  45. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  46. def getNerEntitiesBySentence(annotations: Seq[Annotation], sentenceCount: Int): Seq[Seq[Annotation]]

    Permalink
  47. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  48. final def getOutputCol: String

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

    Permalink
    Definition Classes
    Params
  50. def getRegexEntities(tokensSentence: Seq[IndexedToken], idx: Int): Seq[Annotation]

    Permalink
  51. def getRegexPatternsDictionary: Map[String, Array[String]]

    Permalink
  52. def getSentences(annotations: Seq[Annotation]): Seq[String]

    Permalink
  53. def getTokensBySentence(annotations: Seq[Annotation]): Seq[Seq[IndexedToken]]

    Permalink
  54. def handleEntitiesDifferences(nerEntities: Seq[Annotation], regexEntities: Seq[Annotation]): Seq[Annotation]

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

    Permalink
    Definition Classes
    Params
  56. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  57. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  58. def hashCode(): Int

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

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

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

    Permalink
    Definition Classes
    DeIdentificationModel → HasInputAnnotationCols
  62. final val inputCols: StringArrayParam

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

    Permalink
    Definition Classes
    Params
  64. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  65. def isRegexMatch(token: String, regexPatterns: Array[String]): Boolean

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

    Permalink
    Definition Classes
    Params
  67. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  69. def log: Logger

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. def logName: String

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  81. def mergeEntities(nerEntities: Seq[Annotation], regexEntities: Seq[Annotation]): Seq[Annotation]

    Permalink
  82. val minYear: Param[String]

    Permalink
  83. def msgHelper(schema: StructType): String

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

    Permalink
    Definition Classes
    AnyRef
  85. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  86. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  87. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  88. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    DeIdentificationModel → HasOutputAnnotatorType
  89. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  91. var parent: Estimator[DeIdentificationModel]

    Permalink
    Definition Classes
    Model
  92. val random: Random

    Permalink
  93. val regexPatternsDictionary: MapFeature[String, Array[String]]

    Permalink
  94. def replaceRegExFlavors(word: String): String

    Permalink
  95. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  96. def set[T](feature: StructFeature[T], value: T): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: SetFeature[T], value: Set[T]): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def set[T](feature: ArrayFeature[T], value: Array[T]): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def set(paramPair: ParamPair[_]): DeIdentificationModel.this.type

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

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

    Permalink
    Definition Classes
    Params
  103. def setAllTerms(value: Map[String, List[String]]): DeIdentificationModel.this.type

    Permalink
  104. def setDateTag(s: String): DeIdentificationModel.this.type

    Permalink
  105. def setDateToYear(s: String): DeIdentificationModel.this.type

    Permalink
  106. def setDays(k: String): DeIdentificationModel.this.type

    Permalink
  107. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  109. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  110. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): DeIdentificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. final def setDefault(paramPairs: ParamPair[_]*): DeIdentificationModel.this.type

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

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

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  115. def setLazyAnnotator(value: Boolean): DeIdentificationModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  116. def setMinYear(s: String): DeIdentificationModel.this.type

    Permalink
  117. final def setOutputCol(value: String): DeIdentificationModel.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  118. def setParent(parent: Estimator[DeIdentificationModel]): DeIdentificationModel

    Permalink
    Definition Classes
    Model
  119. def setRegexPatternsDictionary(value: Map[String, Array[String]]): DeIdentificationModel.this.type

    Permalink
  120. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  121. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  122. final def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    AnnotatorModel → Transformer
  123. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  124. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  125. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage
  126. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    DeIdentificationModel → Identifiable
  128. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  129. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  133. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from Licensed

Inherited from AnnotatorModel[DeIdentificationModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[DeIdentificationModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[DeIdentificationModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped