Skip to main content

Generative model for names.

Project description

naamkaran: Generative model for names

https://github.com/appeler/naamkaran/workflows/test/badge.svg https://img.shields.io/pypi/v/naamkaran.svg https://pepy.tech/badge/naamkaran

Naamkaran is a generative model for names. It is a simple character-level RNN that predicts the next character given the previous characters. The model is trained on a list of names from FL Voter Registration Data and can be used to generate new names.

Installation

Naamkaran can be installed from PyPI using pip:

pip install naamkaran

General API

The general API for naamkaran is as follows:

# naamkaran is the package name
from naamkaran.generate import generate_names

# generate_names is the function that generates names
# it takes a start_letter and a number of names to generate

# generate 10 names starting with 'A'
generate_names('A', how_many=10)

positional arguments:
  start_letter  The letter to start the name with

optional arguments:
    end_letter  The letter to end the name with (default: None)
    how_many    The number of names to generate (default: 1)
    max_length  The maximum length of the name (default: 5)
    gender      The gender of the name (default: "M")
    temperature The temperature of the model (default: 0.5)

# generate 10 names starting with 'A' and ending with 'n'
generate_names('A', end_letter='n', how_many=10)

# generate 10 names starting with 'A' and ending with 'n' with a maximum length of 4
generate_names('A', end_letter='n', how_many=10, max_length=4)

# generate 10 names starting with 'A' and ending with 'n' with a maximum length of 6
# and a temperature of 0.5
generate_names('A', end_letter='n', how_many=5, max_length=6, temperature=0.5)

# generate 10 female names starting with 'A' and ending with 'n' with a maximum length of 5
# and a temperature of 0.5
generate_names('A', end_letter='e', how_many=10, max_length=5, gender="F", temperature=0.5)

Data

The data used to train the model is from the Florida Voter Registration Data from early 2022. The data is available here - Florida voter registration database

Authors

Rajashekar Chintalapati and Gaurav Sood

Contributing

Contributions are welcome. Please open an issue if you find a bug or have a feature request.

License

The package is released under the MIT License.

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

naamkaran-0.0.1.tar.gz (595.1 kB view hashes)

Uploaded Source

Built Distribution

naamkaran-0.0.1-py2.py3-none-any.whl (595.0 kB view hashes)

Uploaded Python 2 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