Class/Object

com.johnsnowlabs.nlp.annotators.deid

DeIdentification

Related Docs: object DeIdentification | package deid

Permalink

class DeIdentification extends AnnotatorApproach[DeIdentificationModel] with Licensed

Trains a DeIdentification Annotator which provides functionality to either mask or obfuscate PHI based on Input Annotations of types DOCUMENT, TOKEN and CHUNK.

Ideally this annotator works in conjunction with Demographic Named EntityRecognizers that can be trained either using TextMatchers, RegexMatchers, DateMatchers, NerCRFs or NerDLs

Linear Supertypes
Licensed, AnnotatorApproach[DeIdentificationModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[DeIdentificationModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeIdentification
  2. Licensed
  3. AnnotatorApproach
  4. CanBeLazy
  5. DefaultParamsWritable
  6. MLWritable
  7. HasOutputAnnotatorType
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeIdentification()

    Permalink
  2. new DeIdentification(uid: String)

    Permalink

    uid

    a unique identifier for the instanced Annotator

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

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. final def ==(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit

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

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

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

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

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

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

    Permalink

    Tag representing dates in the obfuscate reference file (default: DATE)

  14. val dateToYear: Param[String]

    Permalink

    'Y' if dates must be converted to years, 'N' otherwise

  15. val days: Param[String]

    Permalink

    Number of days to obfuscate by displacement the dates

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. val description: String

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  24. def finalize(): Unit

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  33. def getLazyAnnotator: Boolean

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

    Permalink
    Definition Classes
    Params
  35. final def getOutputCol: String

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

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

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

    Permalink
    Definition Classes
    Params
  39. def hashCode(): Int

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

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

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

    Permalink
    Definition Classes
    DeIdentification → HasInputAnnotationCols
  43. final val inputCols: StringArrayParam

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

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  49. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Minimum year to use when converting date to year

  62. val mode: Param[String]

    Permalink

    Mode for Anonymizer ['mask'|'ofuscate']

  63. def msgHelper(schema: StructType): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
  67. val obfuscateRefFile: Param[String]

    Permalink

    File with the terms to be used for Obfuscation

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

    Permalink
    Definition Classes
    AnnotatorApproach
  69. val outputAnnotatorType: AnnotatorType

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

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

    Permalink
    Definition Classes
    Params
  72. val refFileFormat: Param[String]

    Permalink

    Format of the reference file for Obfuscation

  73. val refSep: Param[String]

    Permalink

    Separator character for the csv reference file for Obfuscation

  74. val regexPatternsDictionary: ExternalResourceParam

    Permalink

    dictionary with regular expression patterns that match some protected entity

  75. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  79. def setDateTag(s: String): DeIdentification.this.type

    Permalink
  80. def setDateToYear(s: String): DeIdentification.this.type

    Permalink
  81. def setDays(k: String): DeIdentification.this.type

    Permalink
  82. final def setDefault(paramPairs: ParamPair[_]*): DeIdentification.this.type

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  87. def setMinYear(s: String): DeIdentification.this.type

    Permalink
  88. def setMode(m: String): DeIdentification.this.type

    Permalink
  89. def setObfuscateRefFile(f: String): DeIdentification.this.type

    Permalink
  90. final def setOutputCol(value: String): DeIdentification.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  91. def setRefFileFormat(f: String): DeIdentification.this.type

    Permalink
  92. def setRefSep(f: String): DeIdentification.this.type

    Permalink
  93. def setRegexPatternsDictionary(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("delimiter"->" ")): DeIdentification.this.type

    Permalink
  94. def setRegexPatternsDictionary(path: ExternalResource): DeIdentification.this.type

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

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

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

    Permalink

    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
  98. def transformRegexPatternsDictionary(regexPatternsDictionary: Array[(String, String)]): Map[String, Array[String]]

    Permalink
  99. final def transformSchema(schema: StructType): StructType

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

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

    Permalink

    a unique identifier for the instanced Annotator

    a unique identifier for the instanced Annotator

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

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

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from Licensed

Inherited from AnnotatorApproach[DeIdentificationModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[DeIdentificationModel]

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