Skip to content

StephanAkkerman/KanjiControl

Repository files navigation

KanjiControl

banner


Supported versions License Code style: black

Introduction

KanjiControl is a Python project that lets you create mnemonic images of given Japanse kanji and Mandarin Hanzi characters. It's simple to use, simply run src/main.py and give a character and its meaning. The program will then generate a mnemonic image for you, saved in the output folder.

It uses the QR Code Control Net by Monster-Labs to control the Stable Difussion 1.5 model.

Examples

This is an example of a generated mnemonic image for the kanji character "木" (tree): 木

Table of Contents 🗂

Installation ⚙️

The required packages to run this code can be found in the requirements.txt file. To run this file, execute the following code block after cloning the repository:

pip install -r requirements.txt

or

pip install git+https://github.com/StephanAkkerman/KanjiControl.git

Usage ⌨️

Citation ✍️

If you use this project in your research, please cite as follows:

@misc{project_name,
  author  = {Stephan Akkerman},
  title   = {KanjiControl},
  year    = {2025},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/StephanAkkerman/KanjiControl}}
}

Contributing 🛠

Contributions are welcome! If you have a feature request, bug report, or proposal for code refactoring, please feel free to open an issue on GitHub. We appreciate your help in improving this project.
https://github.com/StephanAkkerman/KanjiControl/graphs/contributors

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.