presidio README

The project's README from github.com/data-privacy-stack/presidio. As one markdown file: README.md.

Presidio - Data Protection and De-identification SDK

:mega: Presidio is moving to a new home! Read more here :mega:

Context aware, pluggable and customizable PII de-identification service for text and images.


Build Status MIT license Release OpenSSF Best Practices PyPI pyversions Discord

Component Downloads Coverage
Presidio Analyzer Pypi Downloads Coverage
Presidio Anonymizer Pypi Downloads Coverage
Presidio Image-Redactor Pypi Downloads Coverage
Presidio Structured Pypi Downloads Coverage

What is Presidio

Presidio (Origin from Latin praesidium ‘protection, garrison’) helps to ensure sensitive data is properly managed and governed. It provides fast identification and anonymization modules for private entities in text such as credit card numbers, names, locations, social security numbers, bitcoin wallets, US phone numbers, financial data and more.

Presidio demo gif


:blue_book: Full documentation

:mega: Project transition update

:question: Frequently Asked Questions

:thought_balloon: Demo

:flight_departure: Examples


Goals

Main features

  1. Predefined or custom PII recognizers leveraging Named Entity Recognition, regular expressions, rule based logic and checksum with relevant context in multiple languages.
  2. Options for connecting to external PII detection models.
  3. Multiple usage options, from Python or PySpark workloads through Docker to Kubernetes.
  4. Customizability in PII identification and de-identification.
  5. Module for redacting PII text in images (standard image types and DICOM medical images).

:warning: Presidio can help identify sensitive/PII data in un/structured text. However, because it is using automated detection mechanisms, there is no guarantee that Presidio will find all sensitive information. Consequently, additional systems and protections should be employed.

Installing Presidio

  1. Using pip
  2. Using Docker
  3. From source
  4. Migrating from V1 to V2

Running Presidio

  1. Getting started
  2. Setting up a development environment
  3. PII de-identification in text
  4. PII de-identification in images
  5. Usage samples and example deployments

Support

Contributing

For details on contributing to this repository, see the contributing guide.

This project has adopted the Contributor Covenant Code of Conduct.

Contributors

presidio (data-privacy-stack/presidio)

Searching Database…

11.4K ·GitHub
Что это такое?Открытый фреймворк (SDK), который находит, удаляет, маскирует и анонимизирует чувствительные данные (PII) — имена, номера банковских карт, номера соцстрахования, телефоны — в тексте, изображениях и структурированных данных.
Presidio — это библиотека, которую я подключаю в свой код, или сервис, который я разворачиваю?И то и другое: это Python-пакеты, которые можно импортировать в свой код, а те же компоненты могут работать и как Docker-контейнеры, и в Kubernetes.
Как добавить его в свой проект?Установите Python-пакеты через pip, запустите готовые Docker-образы или соберите из исходников; в документации есть гайд по началу работы — и для обезличивания текста, и для изображений.
Мне нужно приносить свои ML-модели, или распознавание работает сразу из коробки?Распознавание построено на предустановленных или собственных распознавателях: NER (spaCy, Transformers), регулярные выражения, правила на основе логики и контрольные суммы. Можно также подключать внешние модели для поиска PII.
Можно ли рассчитывать, что она найдёт вообще все чувствительные данные?Нет — она полагается на автоматическое распознавание, поэтому гарантии, что будет найдена вся чувствительная информация, нет; авторы советуют использовать её вместе с дополнительными системами и средствами защиты.
Что она распознаёт из коробки?Предустановленные распознаватели охватывают имена, местоположения, номера банковских карт, номера соцстрахования, телефонные номера США, биткоин-кошельки, финансовые данные и многое другое; для специфичных для предметной области сущностей можно добавить свои распознаватели.
Из каких компонентов состоит проект?Из четырёх модулей: Analyzer (находит PII), Anonymizer (удаляет или маскирует её в тексте), Image Redactor (для обычных изображений и медицинских DICOM-изображений) и Presidio Structured (для структурированных данных).
А с языками, кроме английского, он работает?Да — распознаватели используют NER, регулярные выражения и логику на правилах с учётом контекста на нескольких языках, так что распознавание не ограничено английским.
Что означает название Presidio?Оно происходит от латинского praesidium — «защита» или «гарнизон», что перекликается с его задачей оберегать чувствительные данные.
Size
332 MB
Stars
11.4K
Age
8y
Commits · 90 Days