metasyn.distribution.faker

Module for distributions that use the faker package.

Classes

FakerDistribution(faker_type[, locale])	Faker distribution for cities, addresses, etc.
FakerFitter(privacy)	Fitter for the faker distribution.
UniqueFakerDistribution(faker_type[, locale])	Faker distribution that returns unique values.
UniqueFakerFitter(privacy)	Fitter for the unique faker distribution.

class metasyn.distribution.faker.FakerDistribution(faker_type, locale='en_US')

Bases: BaseDistribution

Faker distribution for cities, addresses, etc.

This is mainly an interface for the faker package, so that it can be used within the metasyn package. It doesn’t have any true fitting/statistical inference method, so it has to be manually selected.

Parameters:

• faker_type (str) – The provider function in the faker package, e.g. ‘city’ or ‘ipv4’, etc.

• locale (str) – Locale used for the faker package.

Examples

>>> FakerDistribution(faker_type="city", locale="en_US")
>>> FakerDistribution(faker_type="address", locale="nl_NL")

name

core.faker

unique

False

version

1.0

var_type

string

draw()

Draw a random element from the fitted distribution.

information_criterion(values)

Get the BIC value for a particular set of values.

Parameters:

values (array_like) – Values to determine the BIC value of.

Return type:

float

classmethod default_distribution(var_type=None)

Get a distribution with default parameters.

Return type:

BaseDistribution

name: str = 'core.faker'

The identifier for the implemented distribution

var_type: Union[str, Sequence[str]] = 'string'

The variable type of the distribution

class metasyn.distribution.faker.FakerFitter(privacy)

Bases: BaseFitter

Fitter for the faker distribution.

Parameters:

privacy (BasePrivacy)

dist_class

<class ‘metasyn.distribution.faker.FakerDistribution’>

version

1.0

var_type

string

privacy

none

distribution

alias of FakerDistribution

class metasyn.distribution.faker.UniqueFakerDistribution(faker_type, locale='en_US')

Bases: UniqueDistributionMixin, FakerDistribution

Faker distribution that returns unique values.

See FakerDistribution for examples and explanation.

name

core.faker

unique

True

version

1.0

var_type

string

name: str = 'core.faker'

The identifier for the implemented distribution

var_type: Union[str, Sequence[str]] = 'string'

The variable type of the distribution

class metasyn.distribution.faker.UniqueFakerFitter(privacy)

Bases: FakerFitter

Fitter for the unique faker distribution.

Parameters:

privacy (BasePrivacy)

dist_class

<class ‘metasyn.distribution.faker.UniqueFakerDistribution’>

version

1.0

var_type

string

privacy

none

distribution

alias of UniqueFakerDistribution