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, model_fn: str = '', vocab_fn: str = '') → list[str]
Generates names for the given dataframe.
- Return type:
list[str]
naamkaran.generate module
-
class naamkaran.generate.GenerateNames[source]
Bases: Naamkaran
Generates names for the given dataframe.
-
MODEL_FN = 'models/naamkaran.pt'
-
VOCAB_FN = 'models/names_vec.joblib'
-
static generate(start_letter: str, end_letter: str | None = None, how_many: int = 1, max_length: int = 5, gender: str = 'M', temperature: float = 0.5, model_fn: str = '', vocab_fn: str = '') → list[str][source]
Generates names for the given dataframe.
- Return type:
list[str]
-
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, model_fn: str = '', vocab_fn: str = '') → list[str]
Generates names for the given dataframe.
- Return type:
list[str]
-
naamkaran.generate.main() → list[str][source]
Main method to generates names for the given dataframe.
- Return type:
list[str]
naamkaran.model module
-
class naamkaran.model.NameGenerator(input_size, gender_size, hidden_size, output_size, n_layers=1)[source]
Bases: Module
A class representing the name generator model.
-
__init__(input_size, gender_size, hidden_size, output_size, n_layers=1)[source]
Initialize internal Module state, shared by both nn.Module and ScriptModule.
-
forward(input_seq, gender, hidden)[source]
Forward pass of the model.
-
init_hidden(batch_size, device)[source]
Initialize the hidden state of the LSTM.
naamkaran.naam module
-
class naamkaran.naam.Naamkaran[source]
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][source]
Generates names for the given dataframe.
- Return type:
list[str]
naamkaran.utils module
To process arguments from the command line.
-
naamkaran.utils.get_args(argv: list[str], prog: str, description: str, epilog: str) → Namespace[source]
Returns arguments from the command line.
- Return type:
Namespace