Skip to content

Commit

Permalink
Added comments for highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
fexfl committed Jan 12, 2025
1 parent a2df5be commit 6291531
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions notebook/demo.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Below, the input files are loaded from the given `input_dir` directory. You can provide relative or absolute paths to the directory that contains your `eml` or `html` files. All files of the `eml` or `htlm` file type in that directory will be considered input files."
"The cell below defines a function used to display the result in the end, and highlight all named entities found in the text. It is used for demonstration purposes in this example."
]
},
{
Expand Down Expand Up @@ -67,6 +67,13 @@
" return text"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Below, the input files are loaded from the given `input_dir` directory. You can provide relative or absolute paths to the directory that contains your `eml` or `html` files. All files of the `eml` or `html` file type in that directory will be considered input files."
]
},
{
"cell_type": "code",
"execution_count": null,
Expand Down Expand Up @@ -99,7 +106,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"In the cell below, the emails are looped over and the text is extracted. The text is then split into sentences and the sentences are pseudonymized. The pseudonymized sentences are then joined back into a text and saved to a new file."
"In the cell below, the emails are looped over and the text is extracted. The text is then split into sentences and the sentences are pseudonymized. The pseudonymized sentences are then joined back into a text and saved to a new file.\n",
"\n",
"The input text is displayed and the found named entities are highlighted for demonstration. Note that emails (all words containing '@') are filtered out seperately and thus not highlighted here."
]
},
{
Expand Down

0 comments on commit 6291531

Please sign in to comment.