naamkaran package

Naamkaran is a library to generate random names.

naamkaran.generate_names(start_letter: str, end_letter: str | None = None, how_many: int = 1, max_length: int = 5, gender: str = 'M', temperature: float = 0.5) → List[str]

Generates names for the given dataframe.

Submodules

naamkaran.generate module

class naamkaran.generate.GenerateNames

Bases: Naamkaran

Generates names for the given dataframe.

MODEL_FN = 'models/naamkaran.pt'

VOCAB_FN = 'models/names_vec.joblib'

classmethod generate(start_letter: str, end_letter: str | None = None, how_many: int = 1, max_length: int = 5, gender: str = 'M', temperature: float = 0.5) → List[str]

Generates names for the given dataframe.

naamkaran.generate.generate_names(start_letter: str, end_letter: str | None = None, how_many: int = 1, max_length: int = 5, gender: str = 'M', temperature: float = 0.5) → List[str]

Generates names for the given dataframe.

naamkaran.generate.main() → List[str]

Main method to generates names for the given dataframe.

naamkaran.model module

class naamkaran.model.NameGenerator(input_size, gender_size, hidden_size, output_size, n_layers=1)

Bases: Module

A class representing the name generator model.

__init__(input_size, gender_size, hidden_size, output_size, n_layers=1)

Initialize internal Module state, shared by both nn.Module and ScriptModule.

forward(input_seq, gender, hidden)

Forward pass of the model.

init_hidden(batch_size, device)

Initialize the hidden state of the LSTM.

naamkaran.naam module

class naamkaran.naam.Naamkaran

Bases: object

Generates names for the given start_letter, end_letter

static generate(start_letter: str, end_letter: str | None, how_many: int, max_length: int, gender: str, temperature: float, model_fn: str, vocab_fn: str) → List[str]

Generates names for the given dataframe.

naamkaran.utils module

To process arguments from the command line.

naamkaran.utils.get_args(argv: List[str], description: str, epilog: str) → Namespace

Returns arguments from the command line.