Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deid module update #13506

Merged
merged 1 commit into from
Feb 11, 2023
+10 −9
Merged

deid module update #13506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions docs/en/utility_helper_modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,9 @@ preannotations = pre_annotations)

## Deidentification Module

Spark NLP for Healthcare provides functionality to apply Deidentification using easy-to-use module named `deid`. <br/>
Spark NLP for Healthcare provides functionality to apply Deidentification using easy-to-use module named `Deid`. <br/>

The `deid` module is a tool for deidentifying Personal Health Information from data in a file path. It can be used with custom SparkNLP NER pipelines or without any pipeline specified.
The `Deid` module is a tool for deidentifying Personal Health Information from data in a file path. It can be used with custom SparkNLP NER pipelines or without any pipeline specified.
It returns the deidentification results as a pyspark dataframe as well as a `csv` or `json file`.
The module also includes functionality for applying Structured Deidentification task to data from a file path. <br/>

Expand All @@ -363,9 +363,9 @@ The function, `deidentify()`, can be used with a custom pipeline or without defi
### Apply Deidentification With a Custom Pipeline

```python
from sparknlp_jsl import deid
from sparknlp_jsl import Deid

deid_implementor= deid(
deid_implementor= Deid(
# required: Spark session with spark-nlp-jsl jar
spark
)
Expand Down Expand Up @@ -447,7 +447,8 @@ token="token",
#unnormalized_date=True

#optional: The unnormalized mode. Default is "mask".
#unnormalized_mode="obfuscate")
#unnormalized_mode="obfuscate"
)

```

Expand All @@ -465,9 +466,9 @@ token="token",

```python

from sparknlp_jsl import deid
from sparknlp_jsl import Deid

deid_implementor= deid(
deid_implementor= Deid(
# required: Spark session with spark-nlp-jsl jar
spark
)
Expand Down Expand Up @@ -524,9 +525,9 @@ masking_policy="entity_labels",

```python

from sparknlp_jsl import deid
from sparknlp_jsl import Deid

deid_implementor= deid(
deid_implementor= Deid(
# required: Spark session with spark-nlp-jsl jar
spark
)
Expand Down