semvec/pypi-packages huggingface dataset:
scrubadub-sklearn 2.0.1
Use Spacy NER models to clean personally identifiable information from dirty dirty text.
License: MIT


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


*****************
scrubadub_sklearn
*****************

``scrubadub`` removes personally identifiable information from text.
``scrubadub_sklearn`` is an extension that adds the ability to train custom ML models (such as sklearn) to detect specific items in text.

This package contains several extra detectors:

* ``scrubadub_sklearn.detectors.SklearnDetector`` - A detector that supports tokenising text, featurisation, training, model serialisation, predictions and evaluation.
* ``scrubadub_sklearn.detectors.BIOTokenSklearnDetector`` - Builds upon ``SklearnDetector`` adding support for BIO tagging (e.g. ``B-LOC``, ``I-LOC`` and ``O``).
* ``scrubadub_sklearn.detectors.SklearnAddressDetector`` -  Builds upon ``BIOTokenSklearnDetector`` creating a model to identify addresses.

For more information on how to use scrubadub see the
`scrubadub documentation <https://scrubadub.readthedocs.io/>`_
and the `scrubadub repository <https://github.com/LeapBeyond/scrubadub>`_.


.. image:: https://img.shields.io/github/workflow/status/LeapBeyond/scrubadub_sklearn/Python%20package/main
   :target: https://github.com/LeapBeyond/scrubadub_sklearn/actions?query=workflow%3A%22Python+package%22+branch%3Amain
   :alt:  Build Status
.. image:: https://img.shields.io/pypi/v/scrubadub_sklearn.svg
   :target: https://pypi.org/project/scrubadub_sklearn/
   :alt:  Version
.. image:: https://img.shields.io/pypi/dm/scrubadub_sklearn.svg
   :target: https://pypi.org/project/scrubadub_sklearn/
   :alt:  Downloads
.. image:: https://coveralls.io/repos/github/LeapBeyond/scrubadub_sklearn/badge.svg?branch=master
   :target: https://coveralls.io/r/LeapBeyond/scrubadub_sklearn
   :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/>`_.