Skip to content

appeler/pranaam

Repository files navigation

pranaam: predict religion from name

Documentation Status https://static.pepy.tech/badge/pranaam

Pranaam uses the Bihar Land Records data, plot-level land records (N= 41.87 million plots or 12.13 individuals/accounts across 35,626 villages), to build machine learning models that predict religion and caste from the name. Our final dataset has around 4M unique records. To learn how to transform the data and the models underlying the package, check the notebooks.

The first function we are releasing with the package is pred_rel, which predicts religion based on the name (currently only muslim or not). (For context, nearly 95% of India's population are Hindu or Muslim, with Sikhs, Buddhists, Christians, and other groups making up the rest.) The OOS accuracy assessed on unseen names is nearly 98% for both Hindi and English models.

Our training data is in Hindi. To build models that classify names provided in English, we used the indicate package to transliterate our training data to English.

We are releasing this software in the hope that it enables activists and researchers

  1. Highlight biases
  2. Fight biases
  3. Prevent biases (regress out some of these biases in models built on natural language corpus with person names).

Install

We strongly recommend installing pranaam inside a Python virtual environment. (see venv documentation)

pip install pranaam

General API

  1. pranaam.pred_rel takes a list of Hindi/English names and predicts whether the person is Muslim or not.

Examples

By using names in English

from pranaam import pranaam
names = ["Shah Rukh Khan", "Amitabh Bachchan"]
result = pranaam.pred_rel(names)
print(result)

output -

              name  pred_label  pred_prob_muslim
0    Shah Rukh Khan      muslim              73.0
1  Amitabh Bachchan  not-muslim              27.0

By using names in Hindi

from pranaam import pranaam
names = ["शाहरुख खान", "अमिताभ बच्चन"]
result = pranaam.pred_rel(names, lang="hin")
print(result)

output -

          name  pred_label  pred_prob_muslim
0    शाहरुख खान      muslim              73.0
1  अमिताभ बच्चन  not-muslim              27.0

Functions

We expose one function, which takes Hindi/English text (name) and predicts religion and caste.

  • pranaam.pred_rel(input)
    • What it does:
      • predicts religion based on hindi/english text (name)
    • Output
      • Returns pandas with name and label (muslim/not-muslim)

Authors

Rajashekar Chintalapati, Aaditya Dar, and Gaurav Sood

Contributor Code of Conduct

The project welcomes contributions from everyone! It depends on it. To maintain this welcoming atmosphere and to collaborate in a fun and productive way, we expect contributors to the project to abide by the Contributor Code of Conduct.

License

The package is released under the MIT License.