Python library to analyze names and calculate statistics against a baseline
Project description
pynamebaseline
Python library to analyze names and calculate statistics against a baseline
Usage
Install namebaseline.
pip install namebaseline
Create your baseline and suspicious lists (one string per line)
If the baseline file is baseline.csv and the suspicious file is sus.csv, then you can run the following:
from namebaseline import str_cumdf, chi2_gof_test
# Each file is a list of names, 1 per line
baseline = pd.read_csv("baseline.csv")
sus = pd.read_csv("sus.csv")
# Create Cumulative Distribution Functions
baseline_cumdf = str_cumdf(baseline)
sus_cumdf = str_cumdf(baseline)
# Run Chi-Squared Goodness-of-Fit Test
result = namebaseline.chi2_gof_test(baseline_cumdf, sus_cumdf)
if result.follows_baseline:
print("sus follows baseline")
else:
print("sus does not follow baseline")
To save the baseline cumulative distribution function to use again later:
write_cdf("baseline.json", baseline_cumdf)
To load the baseline cumulative distribution function:
baseline_cumdf = read_cdf("baseline.json")
// TODO: Add more details about transformations
Chi-Square Goodness-of-Fit Test
https://www.itl.nist.gov/div898/handbook/eda/section3/eda35f.htm
Does the sample come from a population with a specific distribution?
Chi-square goodness-of-fit test is applied to binned (classified) data. We create convert all names to floating point values from 0...1, and assign an equal score to each name (1). Conceptually, we are making all names plottable on a x/y grid, with the x position equal to the name value, and the y position equal to the score for that name.
We then create a histogram of all names, summing up the values for each bin. I create 1000 equally-sized bins for this: (0...0.001], (0.001...0.002], ...
This creates our binned counts.
// TODO: Add example image
We can create a probability distribution function by dividing each bin by the total number of names.
// TODO: Add example image
If we plot the baseline and the sample using this distribution, differences are not easily visible. However, if we create a cumulative distribution function from the probability distribution function, the differences are much easier to see.
A cumulative distribution function is created by summing all previous scores as we scan the values from left to right.
By graphing the baseline and sample CDFs together, we can easily see the differences.
// TODO: Add example image
We use the Chi-Square Goodness-of-Fit test to statistically determine whether our sample follows or does not follow our baseline distribution.
The Chi-Square test uses the following null (H_0) and alternate (H_a) hypotheses:
H_0: The data follows the baseline distribution H_a: The data does not follow the baseline distribution
The test statistic (x^2) is calculated from the baseline CDF and sample bins.
N is the total samples size. O_i is the count of samples in bin i. E_i is the expected counts in bin i based on the baseline.
x^2 = sumi=1...k^2 / E_i
E_i = N*(CDF_baseline(i) - CDF_baseline(i-1))
alpha: significance level = 0.05 (95% confidence)
Critical Region: k: non-empty cells (1000) c: estimated distribution function parameters (0) + 1
The test statistic follows an (approximately) X^2 distribution with (k-c) degrees of freedom)
Reject if X^2 > X^2_(1-a,k-c)
The critical value is calculated using scipy.stats.chi2.ppf(q, df)
where q = 1-a, df = the degrees of freedom
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file namebaseline-0.1.tar.gz.
File metadata
- Download URL: namebaseline-0.1.tar.gz
- Upload date:
- Size: 53.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a29d1a59d17b06705e6a9fc1f04540cdf0a60950cd444ad30de7279f59b89d39
|
|
| MD5 |
96f55bfc35eb8198092ae497c10ed748
|
|
| BLAKE2b-256 |
af750494db3d1e73ffa8fbc4632fee709bc423ba4bca66ed4a9d4ae2e3064ae4
|
File details
Details for the file namebaseline-0.1-py3-none-any.whl.
File metadata
- Download URL: namebaseline-0.1-py3-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e9ece0308667d4ecbf50d446e74395e476d3fedb289411d734af89d2b1a98ab9
|
|
| MD5 |
906c3c134ca13460b8640b293e19fd34
|
|
| BLAKE2b-256 |
e28d77fdfebc0e595565bcd8e00ff1bd0f690301bc9af2cdb5dbf027d3ed2e2a
|