-
Notifications
You must be signed in to change notification settings - Fork 7
docs: define sensitivity and protection method #151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
asteier2026
wants to merge
5
commits into
main
Choose a base branch
from
asteier2026/docs/sensitivity
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+22
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
861e645
feature: add docs for sensitivity and protection method
asteier2026 1bd9a4b
fix: address review feedback on sensitivity
asteier2026 0510118
fix: undoing change I made to wrong PR
asteier2026 1a8c2a0
Update docs/concepts/rewrite.md
asteier2026 1e9d449
fix: add more detail and organization to definitions
asteier2026 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,28 @@ The text is then rewritten to reduce identifiability, applying targeted transfor | |
|
|
||
| --- | ||
|
|
||
| ## Key concepts | ||
|
|
||
| **Sensitivity** measures the intrinsic re-identification damage an entity causes if it appears in the output — independently of what else is retained. It is not the protection decision; it feeds the downstream leakage scoring system. | ||
|
|
||
| | Level | Meaning | Examples | Leakage weight | | ||
| |-------|---------|---------|----------------| | ||
| | `high` | Exposure alone can identify a person | Names, ID numbers, contact details | 1.0 | | ||
| | `medium` | Meaningfully narrows the identity space | Location, occupation, age | 0.6 | | ||
| | `low` | Minimal standalone identifying power | Generic attributes, widely shared traits | 0.3 | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You could add gender here as an example as well! |
||
|
|
||
| **Protection method** describes how a sensitive entity is transformed. The choice reflects a holistic view of the document — what other entities are being protected and how, then shapes what each individual entity needs. | ||
|
|
||
| | Method | What it does | Typical use | | ||
| |--------|-------------|-------------| | ||
| | `replace` | Substitutes the entity with a plausible synthetic alternative | Direct identifiers (names, IDs, contact details) | | ||
| | `generalize` | Replaces the entity with a broader form | Quasi-identifiers (exact date → quarter, city → region) | | ||
| | `suppress_inference` | Rewrites the surrounding text to remove cues that enable the inference | Latent entities that are implied rather than stated | | ||
| | `remove` | Deletes the entity entirely | Cases where neither replacement nor generalization can preserve meaning without retaining the identifying detail | | ||
| | `leave_as_is` | Leaves the entity unchanged | Entities judged not to require protection in context | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could also use gender as an example here |
||
|
|
||
| --- | ||
|
|
||
| ## Basic usage | ||
|
|
||
| ```python | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.