scrubadub-stanford 2.1.3
Use the Stanford NER model to clean personally identifiable information from dirty dirty text.
License: MIT


.. NOTES FOR CREATING A RELEASE:
..
..   * bump the version number in scrubadub_stanford/__init__.py
..   * update docs/changelog.rst
..   * git push
..   * create a release https://github.com/LeapBeyond/scrubadub_stanford/releases
..      * This should trigger a github action to upload to pypi
..      * ReadTheDocs.io should see any changes and also rebuild the docs


******************
scrubadub_stanford
******************

``scrubadub`` removes personally identifiable information from text.
``scrubadub_stanford`` is an extension that uses Stanford's NER model to remove personal information from text.

This package contains three flavours of interfacing with Stanford's NER models that can be used as a detector:

* ``scrubadub_stanford.detectors.StanfordEntityDetector`` - A detector that uses the Stanford NER model to find locations, names and organizations. Download size circa 250MB.
* ``scrubadub_stanford.detectors.CoreNlpEntityDetector`` - The same interface as the ``StanfordEntityDetector``, but using Stanza's ``CoreNLPClient`` to interface with the CoreNLP Java Server. Download size circa 510MB.
* ``scrubadub_stanford.detectors.StanzaEntityDetector`` - Similar to the above but using Stanza's native Python pipelines. Download size circa 210MB. No Java required. This is the recommended detector for speed and footprint.

Prerequisites
-------------

A minimum version of Java Runtime Environment 8 is required for ``StanfordEntityDetector`` and ``CoreNlpEntityDetector``.
Check which version by running::

    $ java -version

It should be at least version 1.8, but if not, please run the following commands:

Linux::

    $ sudo apt update
    $ sudo apt install openjdk-8-jre

MacOS::

    $ brew tap adoptopenjdk/openjdk
    $ brew install adoptopenjdk8-jre

For more information on how to use this package see the
`scrubadub stanford documentation <https://scrubadub.readthedocs.io/en/develop/names.html#stanford>`_
and the `scrubadub repository <https://github.com/LeapBeyond/scrubadub>`_.


.. image:: https://img.shields.io/github/workflow/status/LeapBeyond/scrubadub_stanford/Python%20package/main
   :target: https://github.com/LeapBeyond/scrubadub_stanford/actions?query=workflow%3A%22Python+package%22+branch%3Amain
   :alt:  Build Status
.. image:: https://img.shields.io/pypi/v/scrubadub_stanford.svg
   :target: https://pypi.org/project/scrubadub_stanford/
   :alt:  Version
.. image:: https://img.shields.io/pypi/dm/scrubadub_stanford.svg
   :target: https://pypi.org/project/scrubadub_stanford/
   :alt:  Downloads
.. image:: https://coveralls.io/repos/github/LeapBeyond/scrubadub_stanford/badge.svg?branch=main
   :target: https://coveralls.io/r/LeapBeyond/scrubadub_stanford
   :alt:  Test Coverage
.. image:: https://readthedocs.org/projects/scrubadub/badge/?version=latest
   :target: https://readthedocs.org/projects/scrubadub/?badge=latest
   :alt:  Documentation Status


New maintainers
---------------

`LeapBeyond <http://leapbeyond.ai/>`_ are excited to be supporting scrubadub with ongoing maintenance and development.
Thanks to all of the contributors who made this package a success, but especially `@deanmalmgren <https://github.com/deanmalmgren>`_, `IDEO <https://www.ideo.com/>`_ and `Datascope <https://datascopeanalytics.com/>`_.