EdyVision / pii-codex

A research python package for detecting, categorizing, and assessing the severity of personal identifiable information (PII)
BSD 3-Clause "New" or "Revised" License
70 stars 10 forks source link

Er.add documentation #30

Closed EdyVision closed 1 year ago

EdyVision commented 1 year ago

Overview

PR description. Explain what it's doing and why.

Checklist

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage has no change and project coverage change: -0.01 :warning:

Comparison is base (f51f9d9) 97.53% compared to head (2cafff6) 97.53%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #30 +/- ## ========================================== - Coverage 97.53% 97.53% -0.01% ========================================== Files 27 27 Lines 1219 1217 -2 ========================================== - Hits 1189 1187 -2 Misses 30 30 ``` | [Impacted Files](https://codecov.io/gh/EdyVision/pii-codex/pull/30?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Eidan+Rosado) | Coverage Δ | | |---|---|---| | [pii\_codex/models/common.py](https://codecov.io/gh/EdyVision/pii-codex/pull/30?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Eidan+Rosado#diff-cGlpX2NvZGV4L21vZGVscy9jb21tb24ucHk=) | `100.00% <ø> (ø)` | | | [...ters/detection\_adapters/azure\_detection\_adapter.py](https://codecov.io/gh/EdyVision/pii-codex/pull/30?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Eidan+Rosado#diff-cGlpX2NvZGV4L3NlcnZpY2VzL2FkYXB0ZXJzL2RldGVjdGlvbl9hZGFwdGVycy9henVyZV9kZXRlY3Rpb25fYWRhcHRlci5weQ==) | `100.00% <ø> (ø)` | | | [pii\_codex/utils/pii\_mapping\_util.py](https://codecov.io/gh/EdyVision/pii-codex/pull/30?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Eidan+Rosado#diff-cGlpX2NvZGV4L3V0aWxzL3BpaV9tYXBwaW5nX3V0aWwucHk=) | `96.92% <ø> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Eidan+Rosado). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Eidan+Rosado)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.