PseudoAnonymizedFaker

Compatibility: pii data
The PseudoAnonymizedFaker pseudo-anonymizes private or sensitive data. When transforming the column, it converts the original data to numerical values. When reversing the transform, it pseudo-anonymizes the column by mapping each value to a completely new, fake data using the Python Faker library. Note that the mapping is consistent so the real, sensitive values can be recovered. 
from rdt.transformers.pii import PseudoAnonymizedFaker
​
paf = PseudoAnonymizedFaker()
You can specify the exact faker method to use for more realistic data.
Parameters
provider_name: The name of the provider to use from the Faker library.
(default) None
Use the BaseProvider from Faker, which capable of creating random text.
<string>
Use the provider for a specific context, for example "address" or "bank".
function_name: The name of the function to use within the Faker provider.
(default) 'lexify'
Use the lexify method to create random 4-character text.
<string>
Use the function from the specified provider to generate fake data. For example, "street_address" from the address provider or "swift" from the bank provider.
Together, the provider_name and function_name parameters specify exactly how to create fake data. Some common values are:
A full address: provider_name="address", function_name="address"
A basic bank account number: provider_name="bank", function_name="bban"
A full credit card number: provider_name="credit_card", function_name="credit_card_number"
​Latitude/longitude coordinates: provider_name="geo", function_name="local_latlng"
A phone number: provider_name="phone_number", function_name="phone_number"
To browse for more options, visit the Faker library's docs.
function_kwargs: Optional parameters to pass into the function that you're specifying to create Fake data.
(default) None
Do not specify any additional parameters
<dictionary>
Additional parameters to add. These are unique to the function name and should be represented as a dictionary.

For example for the banking "swift" function, you can specify: {"length": 11, "primary": True}.
locales: An optional list of locales to use when generating the Fake data.
(default) None
Use the default locale, which is usually set to the country you are in.
<list>
Create data from the list of locales. These are specified as strings representing the language and country from Faker. 

For example ["en_US", "fr_CA"].
Setting a locale might leak information about the original data. Anyone with access to the anonymized data will be able to tell which countries and locales are included in the original data .
Examples
from transformers.pii import PseudoAnonymizedFaker
​
# create more realistic-looking data by specifying a provider and function
paf = PseudoAnonymizedFaker(
    provider_name="person",
    function_name="name")
FAQs
When should I use this transformer?
Use the PseudoAnonymizedFaker whenever you have sensitive data that should not be part of your data science project. By default, the transformer reverses the transform into fake, 4-character strings such as "UaNJ" in place of the original, sensitive data.
Use this transformer as-is if the values in your sensitive data do not matter. Alternatively, supply a provider and function name to create fake data that looks more realistic.
Will any of the real values show up in the fake data?
The PseudoAnonymizedFaker generates data randomly without looking at the real values. So there is a small chance that a real value may show up in the real data by complete coincidence. For example, if your real data had a phone number "(617)123-4567", there's a small probability that the exact same phone number will be created by random chance. It may or may not map to a different number.
This behavior actually protects your sensitive data! Otherwise, anyone with access to the fake data would be able to deduce the real values by noting down what's missing.
What is the difference between the AnonymizedFaker and the PseudoAnonymizedFaker?
Pseudo-anonymization indicates that the scheme can be reversed while anonymization indicates that it's permanent.
This transformer pseudo-anonymizes data in a reversible way using consistent mapping between the original and fake data. This behavior allows you to add protection to your original data while also providing the option to recover the sensitive values. Note that anyone with access to the transformer will be able to lookup the mapping and uncover the real values.
If you want to prevent the possibility of recovering sensitive values, use the AnonymizedFaker instead.
Can I access the mapping that is used?
Yes. This transformer has a get_mapping() function that will return the mapping. 
If you are using a HyperTransformer access the transformer through the config.
# assume ht is a HyperTransformer that is already fit
paf = ht.get_config()['transformers']['person']
paf.get_mapping()
{
    'Tim Berners-Lee': 'Amber Lee',
    'Ada Lovelace': 'Christopher Brown',
    'Grace Hopper': 'Amanda Jackson'
}

OptimizedTimestampEncoder

RegexGenerator

Last modified 4mo ago

(default) `None`	Use the BaseProvider from Faker, which capable of creating random text.
`<string>`	Use the provider for a specific context, for example `"address"` or `"bank"`.

(default) `'lexify'`	Use the lexify method to create random 4-character text.
`<string>`	Use the function from the specified provider to generate fake data. For example, `"street_address"` from the address provider or `"swift"` from the bank provider.

(default) `None`	Do not specify any additional parameters
`<dictionary>`	Additional parameters to add. These are unique to the function name and should be represented as a dictionary. For example for the banking `"swift"` function, you can specify: `{"length": 11, "primary": True}`.

(default) `None`	Use the default locale, which is usually set to the country you are in.
`<list>`	Create data from the list of locales. These are specified as strings representing the language and country from Faker. For example `["en_US",` `"fr_CA"]`.