Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,47 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: mit
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
---
|
| 4 |
+
# isekai-rolename-vae
|
| 5 |
+
|
| 6 |
+
This project is designed to generate character names for isekai-style light novels using a GRU-Seq2Seq-VAE model.
|
| 7 |
+
|
| 8 |
+
## Overview
|
| 9 |
+
|
| 10 |
+
The `isekai-rolename-vae` project leverages neural networks to assist writers in crafting unique and fitting character names for isekai light novels. The model produces names that are easy to pronounce and align with genre conventions, without carrying specific meanings.
|
| 11 |
+
|
| 12 |
+
## Key Features
|
| 13 |
+
|
| 14 |
+
- **GRU-Seq2Seq-VAE Model**: Integrates GRU, Seq2Seq learning, and VAE to generate character names.
|
| 15 |
+
- **User-Friendly Interface**: Simplified setup for input parameters and retrieval of generated names.
|
| 16 |
+
|
| 17 |
+
## Getting Started
|
| 18 |
+
|
| 19 |
+
To begin using `isekai-rolename-vae`, follow these steps:
|
| 20 |
+
|
| 21 |
+
1. **Installation**: Clone the repository or download the source code.
|
| 22 |
+
```bash
|
| 23 |
+
git clone https://huggingface.co/Sunbread/isekai-rolename-vae
|
| 24 |
+
```
|
| 25 |
+
2. **Dependencies**: Install the necessary Python libraries, including PyTorch.
|
| 26 |
+
3. **Inference**: Run the model to generate character names.
|
| 27 |
+
|
| 28 |
+
## Usage
|
| 29 |
+
|
| 30 |
+
To generate character names, execute the `inference.py` script from the command line. The script will output 16 names at a time:
|
| 31 |
+
|
| 32 |
+
```bash
|
| 33 |
+
cd isekai-rolename-vae
|
| 34 |
+
python ./inference.py
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
This command will load the model and generate 16 new character names for your isekai light novel.
|
| 38 |
+
|
| 39 |
+
## Acknowledgements
|
| 40 |
+
|
| 41 |
+
This project draws inspiration from the creative challenge of naming characters in isekai light novels, as explored in the article ["起名废即使在写异世界转生轻小说时也要从容生存——用GRU-Seq2Seq-VAE生成异世界轻小说人物名吧！"](https://zhuanlan.zhihu.com/p/637430709). The innovative use of neural networks for generating character names was a key influence in developing this project.
|
| 42 |
+
|
| 43 |
+
## License
|
| 44 |
+
|
| 45 |
+
This project is licensed under the [MIT License](LICENSE). Feel free to use and modify the code for your own projects.
|
| 46 |
+
|
| 47 |
+
Happy writing, and may your isekai characters come to life with distinctive names from this tool!
|