knead is a command line tool for preprocessing, manipulating and serializing font files for deep learning applications.

Table of Contents

• Installation
• Usage
• Documentation
• Contributing
• License

Installation

The latest release of knead can be installed from PyPI:

pip install knead

Usage

knead --input INPUT_FORMAT --output OUTPUT_FORMAT --directory PATH/TO/DATA/

1. The --input and --output flags must be one of:

• ttf: a .ttf font file.
• ttx: a .ttx XML format of the font. For more details, refer to the fonttools documentation.
• json: a .json format of the font.
• pb: a .pb serialized protobuf format of each glyph in each font.
• npy: a .npy format of samples from quadratic Bezier curves in each glyph in each font.

1. The --directory must have the following structure:

data
└── ttf
    ├── Georgia.ttf
    └── ...

Refer to our quickstart for more information on how to use knead.

Documentation

Please refer to our full documentation.

Contributing

Contributions are always welcome! Please see our issue tracker for outstanding issues, code of conduct for community guidelines, and our contributing guide for details on how to make a contribution.

License

knead is licensed under the MIT license.