Skip to main content

Predict race from name and location

Project description

pyethnicity:

PyPI version PyPI - Downloads License: MIT Tests pre-commit Checked with mypy Code style: black Imports: isort

What is it?

pyethnicity is a Python package to predict race from name and location. To the best of the author's knowledge, it outperforms all existing open-source models. It does this by training a Bidirectional LSTM on the largest, most comprehensive dataset of name and self-reported race thus far. It uses voter registration data from all 50 states. Additionally, it incorporates location features and improved versions of Bayesian Improved Surname Geocoding and Bayesian Improved Firstname Surname Geocoding to form an ensemble model that achieves up to 36.8% higher F1 scores than the next-best performing model.

pyethnicity

rethnicity

ethnicolr

Please see the correpsonding paper "Can We Trust Race Prediction?" for more details.

Usage:

Please see https://pyethnicity.readthedocs.io/en/latest/ for full documentation.

Installing

The easiest way is to install pyethnicity is from PyPI using pip:

pip install pyethnicity

Running

Pyethnicity exposes several functions. It supports block group, tract, and zip code level features. Each function takes in a scalar or array-like of inputs and returns a pandas DataFrame of the input and the predictions. Note that pyethnicity expects the census tract to be in the format of 2-digit state FIPS, 3-digit county FIPS, and 6-digit tract.

import pyethnicity

zcta = 27106
tract = 72153750502
first_name = "cangyuan"
last_name = "luo"

pyethnicity.bisg(last_name, zcta, geo_type="zcta")
pyethnicity.bifsg(first_name, last_name, tract, geo_type="tract")
pyethnicity.predict_race_fl(first_name, last_name)
pyethnicity.predict_race_flg(first_name, last_name, tract, geo_type="tract")
pyethnicity.predict_race(first_name, last_name, zcta, geo_type="zcta")

TODO:

  • Following the CFPB, when a compound name doesn't match, try to match on both parts of the name.
  • Re-train model to support Native American and Multiracial.

This package is still in active development. Please report any issues!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyethnicity-0.0.18.tar.gz (33.7 MB view hashes)

Uploaded Source

Built Distribution

pyethnicity-0.0.18-py3-none-any.whl (33.7 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page